Player FM - Internet Radio Done Right
Checked 2+ y ago
اضافه شده در three سال پیش
محتوای ارائه شده توسط Write the Docs Podcast. تمام محتوای پادکست شامل قسمتها، گرافیکها و توضیحات پادکست مستقیماً توسط Write the Docs Podcast یا شریک پلتفرم پادکست آنها آپلود و ارائه میشوند. اگر فکر میکنید شخصی بدون اجازه شما از اثر دارای حق نسخهبرداری شما استفاده میکند، میتوانید روندی که در اینجا شرح داده شده است را دنبال کنید.https://fa.player.fm/legal
Player FM - برنامه پادکست
با برنامه Player FM !
با برنامه Player FM !
پادکست هایی که ارزش شنیدن دارند
حمایت شده
"It is a scientific fact that these macaques, like all other primates, including humans, are communicating. They communicate in much the same way we do - facial expressions, vocalizations, body postures, those kinds of things." - Jeff Kerr Jeff Kerr is PETA foundations Chief Legal Officer. I asked him to come on the show to talk about one of PETA’s current lawsuits against the National Institutes of Health (NIH) and Nathional Institute of Mental Health (NIMH). PETA is arguing that the monkeys being tested on in a government run facility are capable of communication (or “are communicating”). And that we have a constitutional right under the First Amendment to receive their communications. This could be a game changer in allowing us to see what’s really going on in labs that are funded by taxpayer money, and which have so far been censored from public view. PETA’s lawsuit follows years of NIH’s attempts to deny Freedom of Information requests banning PETA executives from its campus and illegally censoring animal advocates’ speech on NIH’s public social media pages. Through the lawsuit, PETA is seeking a live audio-visual feed to see and hear real-time communications from the macaques who have been kept isolated, used in fear experiments, and had posts cemented into their heads. Anthropologists and other scientists have studied macaque and other primate communications for decades and know that the monkeys communicate effectively and intentionally through lip smacking, fear grimaces, body language, and various cries and sounds—all of which constitute speech under the law. Primatologists can analyze that speech on a deeper level to share their stories with the world.…
WTD Episode 17: Structured writing — reasons and approaches
Manage episode 344329428 series 3405918
محتوای ارائه شده توسط Write the Docs Podcast. تمام محتوای پادکست شامل قسمتها، گرافیکها و توضیحات پادکست مستقیماً توسط Write the Docs Podcast یا شریک پلتفرم پادکست آنها آپلود و ارائه میشوند. اگر فکر میکنید شخصی بدون اجازه شما از اثر دارای حق نسخهبرداری شما استفاده میکند، میتوانید روندی که در اینجا شرح داده شده است را دنبال کنید.https://fa.player.fm/legal
In this Write the Docs podcast episode, we chat with Mark Baker about structured writing, specifically focusing on his new book Structured Writing: Rhetoric and Process. After introducing and defining structured writing, Mark explains the four domains you can add structure: media, document, subject, and management domains. He explains the advantages of working with structure in the subject domain, and why mixing structure across subject and document domains can be inefficient. We also chat about how structured writing connects with SEO and microformats on the semantic web, the limits of structure in Markdown formats, how to implement structure in linking, and more.
…
continue reading
35 قسمت
Manage episode 344329428 series 3405918
محتوای ارائه شده توسط Write the Docs Podcast. تمام محتوای پادکست شامل قسمتها، گرافیکها و توضیحات پادکست مستقیماً توسط Write the Docs Podcast یا شریک پلتفرم پادکست آنها آپلود و ارائه میشوند. اگر فکر میکنید شخصی بدون اجازه شما از اثر دارای حق نسخهبرداری شما استفاده میکند، میتوانید روندی که در اینجا شرح داده شده است را دنبال کنید.https://fa.player.fm/legal
In this Write the Docs podcast episode, we chat with Mark Baker about structured writing, specifically focusing on his new book Structured Writing: Rhetoric and Process. After introducing and defining structured writing, Mark explains the four domains you can add structure: media, document, subject, and management domains. He explains the advantages of working with structure in the subject domain, and why mixing structure across subject and document domains can be inefficient. We also chat about how structured writing connects with SEO and microformats on the semantic web, the limits of structure in Markdown formats, how to implement structure in linking, and more.
…
continue reading
35 قسمت
همه قسمت ها
×W
Write the Docs Podcast

In this podcast, we discuss the newly released book Docs for Developers: An Engineer's Field Guide to Technical Writing with Jared Bhatti, staff technical writer at Google, and Zachary Sarah Corleissen, staff technical writer at Stripe (two of the co-authors). This book on writing documentation focuses on the end-to-end writing process (from audience analysis to drafting, editing, publishing, and more) and is written specifically with developers in mind. The authors use the scenario of documenting Corg.ly, an API that translates barks, as a common thread through each of the chapters.…
W
Write the Docs Podcast

In this podcast, Fabrizio Ferri joins us for a discussion about adding both personal identity and personality to documentation. Why are the docs we write so often anonymous, and does that anonymity work against progress in our careers? Are tech writers, who are typically introverts, averse to publicity, or does our industry not allow for it? And if you want to be a "personality" in the tech communications world, what do you do? How do you add personality constructively to your work without disrupting corporate brand and consistency?…
One of the most challenging and frustrating things about being a tech writer is managing screenshots in your product documentation. How many times have you needed to take complex screenshots of your product and meticulously marked them up with callouts only to be told that a field has changed and you need to do everything again? It’s so frustrating and demoralizing as a writer because it feels like wasted effort. What if there was a way to create screenshots that could withstand the rapid iterations of a product under development while still conveying valuable meaning to your readers. Today we’re joined by Anton Bollen from TechSmith who explains how we can do this using low-detail screenshots, aka simplified user interfaces, that let you focus your users' attention on just the bits of the interface that matter.…
Many tech writers are familiar with using AsciiDoc for documentation, but did you know that you can also create fiction and non-fiction books with AsciiDoc, publishing to popular digital formats such as EPUB or PDF, along with HTML? In this episode of the Write the Docs podcast, we chat with Mehmed Pasic from Manning Publications about self-publishing, AsciiDoc, collaborative workflows between authors and editors, trends in book publishing, the most popular devices for consuming content, book versus video formats for technical content, and more.…
W
Write the Docs Podcast

1 WTD Episode 31: Strategies for site search, with Peter Levan 1:00:57
1:00:57
پخش در آینده
پخش در آینده
لیست ها
پسندیدن
دوست داشته شد1:00:57
So many documentation websites rely on search as part of their information architecture. But what do you actually need to consider if you want to make your site search return answers for users in relevant, efficient ways? Join Peter Levan from Funnelback with regular guests Chris, Jared, and Tom for a talk all about making search work well on your site. Some of the questions discussed include: Why can't you just let Google do the searching and indexing for you? Do you need to pay big money to get a site search tool? How do you make your docs site talk robot ?…
W
Write the Docs Podcast

1 WTD Episode 30: Documentation templates, with Juan Lara 1:01:56
1:01:56
پخش در آینده
پخش در آینده
لیست ها
پسندیدن
دوست داشته شد1:01:56
In this episode, Juan Lara from Google joins us for a lively discussion about documentation templates. Documentation templates refer to established patterns we follow for common documentation types, such as quickstarts, how-to guides, concepts, tutorials, reference, troubleshooting, release notes, FAQs, or other information types that have similar, predictable patterns. Templates can be helpful in orienting new writers, but they can also help ensure consistency among larger groups of experienced writers too. Our discussion in this episode ranges from observations about when templates are right for users versus writers, and how templates fit into an overall content strategy and information architecture. Beyond templates, your user's goals and journeys will influence the shape of your help content.…
W
Write the Docs Podcast

In this episode, we chat with Eric Holscher, co-founder of both Read the Docs and Write the Docs, about the recent Salary Survey that the WTD group conducted. This survey was launched in Fall 2019, and the results published were recently published. The salary survey covers details such as types of employment, job titles, roles, length of time in role, work location, annual salary, salary breakdowns by state, additional benefits, satisfaction, reasons for dissastisfaction, organization type, respondent demographics, and more. In addition to exploring the survey, we also chat about tips for working from home, especially given that both Eric and Chris have been working remotely for many years.…
W
Write the Docs Podcast

1 WTD Episode 28: UX writing - Starting and Scaling at your Company, Berlin WTD meetup 1:14:54
1:14:54
پخش در آینده
پخش در آینده
لیست ها
پسندیدن
دوست داشته شد1:14:54
Episode 28 is a recording of a Berlin WTD meetup focused on UX writing processes, live streamed on March 9, 2020 at the Humanitec in Berlin. The meetup featured two speakers. Natasha Sarana, UX Writer at FlixMobility, talks about her company's attempts to include UX Writing in their research routine. She shares the main challenges they faced so far and how they deal with them. The second speaker, Roger Sheen, information architect and freelance UX Writer, talks about how the UI copy process at Wire evolved as the product matured. He covers gathering and aligning copy from source code, moving it to dedicated strings files to facilitate version control and localization, and setting up collaboration workflows with developers and external partners.…
In episode 27 of the Write the Docs podcast, we're joined by Cynthia Ng and Amy Qualls from GitLab to talk about strategies for starting up docs in organizations where there aren't any other tech writers and where you're first on scene setting up shop. What are your first steps as a documentarian when there isn't anyone else, when processes, contacts, tools, and other systems aren't documented or described anywhere? When you're first on scene, docs might not even be your full-time job but rather a task that's on the side of your desk and which you have to bootstrap from ground zero.…
W
Write the Docs Podcast

1 WTD Episode 26: Tech Writing and Reddit, with Alan Bowman 1:04:24
1:04:24
پخش در آینده
پخش در آینده
لیست ها
پسندیدن
دوست داشته شد1:04:24
In episode 26, we talk with Alan Bowman about the technical writing forum on Reddit as well as the WTD Slack channel, comparing and contrasting the two spaces. Topics covered include pros and cons of anonymity on the internet, transparency around sensitive or taboo topics (e.g., salary, masters programs, feelings of overwhelm), age/experience demographics for both communities, balancing honesty with professionalism, responding to posts from overwhelmed tech writers, dealing with recurring topics, strategies for participating, and more.…
W
Write the Docs Podcast

In episode 25, we talk with Andrew Head, Ph.D. Candidate in Computer Science at UC Berkeley, about his research on how developers use API documentation. Specifically, we focused on a recent article he co-authored titled When Not to Comment: Questions and Tradeoffs with API Documentation for C++ Projects . During the podcast, we chat about the following: where developers look for information, how developers manage information in Google’s unique billion-line code base, when it's appropriate to just let developers read the code directly versus creating documentation, what kind of information developers look for in API documentation, the relevance of document generators such as Doxygen, and more. Andrew also talked about some projects he's working on to build interactive tools for developers to share code expertise.…
W
Write the Docs Podcast

In this episode, we're joined by the Write the Docs Australia initiator Swapnil Ogale. We talk about conference wind-downs and ramp-ups, highlights from the just-finished WTD Prague conference, speakers announced for upcoming Write the Docs Australia conference, the Good Docs Project, the tech writing scene in Australia, and more.…
W
Write the Docs Podcast

In this episode, rather than the usual roundtable discussion, we provide a recording of a WTD Berlin presentation by Lucie Le Naour on how to write inclusive tech documentation. Inclusive documentation takes into account all users, regardless of their gender, culture, or abilities. It uses language that treats different types of people fairly and equally, acknowledging that the words you choose matter in the connotations and attitudes they convey. This presentation was recorded on August 19, 2019 in Berlin.…
W
Write the Docs Podcast

1 WTD Episode 22: Managing multiple doc projects across Git repositories, with Giles Gaskell 1:01:40
1:01:40
پخش در آینده
پخش در آینده
لیست ها
پسندیدن
دوست داشته شد1:01:40
In episode 22, Giles Gaskell from Squiz in Australia joins us to talk about managing multiple doc projects across Git repositories through Antora. Giles explains how to establish processes such that updating documentation becomes part of the definition of done, how to manage build process across multiple Gitlab repositories, strategies for distributing doc work across engineers through templates, how to scale workloads when you're the lone technical writer in the company, times when dogfooding your own product for docs makes sense and when it does not, pros and cons of Asciidoc versus Markdown, and more docs-as-code topics.…
W
Write the Docs Podcast

1 WTD Episode 21: On career growth, leadership, and mentoring in tech writing, with Becky Todd 59:21
In episode 21, Becky Todd from Atlassian joins us to talk about career growth, leadership, and mentoring. How do you move up to the next level at your company? Does upleveling require a management track, or there other ways to increase your leadership and influence? We also chat about mistakes we've made, what we've learned, ways to increase our influence and visibility both inside and outside corporate walls, why we sometimes back away from persuasion efforts, the balance between autonomy and micromanagement, mentoring strategies and opportunities, and other career-related topics within technical communication. We also look at the Season of Docs as an opportunity for getting involved in open source projects.…
In this episode, we explore where technical writers belong in an organization. Is tech comm best placed within engineering, marketing, product management, or another group? We also talk about strategies for doc navigation, in particular, the merits of inline links and/or sidebar navigation, using a post from Every Page Is Page One as a starting point. Are hierarchical sidebar menus still useful, or are they a relic of the past? Finally, we provide details about the upcoming Write the Docs conference in Portland, and Chris mentions his new book on responsive design.…
In this episode, we talk about continuous integration strategies for docs (for style, screenshots, and REST calls). We also dive into discussions around docs as code, including how to encourage developer collaboration, how to stay informed about the code updates that developers make, and more.
In this episode, we discuss top technical writing trends for 2017. Chris discusses how more technical writers are interacting with support groups, and even being embedded within support departments. Jared discusses how docs are being planned for earlier in development cycles, as more product managers are seeing the value of docs. Tom talks about how more technical writers are treating documentation as code, and the challenges inherent in developer tools and workflows.…
W
Write the Docs Podcast

In episode 2 of the Write the Docs podcast, we explore how to help users find what they're looking for in your documentation. We talk about various tools for findability: search, tags, faceted filters, sidebar navigation, inline links, related links, terms/glossaries, and breadcrumbs.
In this first episode, we introduce the co-hosts, the podcast theme, and chat about a few articles. The four co-hosts include Jared Morgan, Carlee Potter, Chris Ward, and Tom Johnson. We're located in Sydney, Brisbane, Berlin, and California. In this episode, we chat about content strategy, style guides, abbreviations and acronyms, developer-written UI copy, and more.…
به Player FM خوش آمدید!
Player FM در سراسر وب را برای یافتن پادکست های با کیفیت اسکن می کند تا همین الان لذت ببرید. این بهترین برنامه ی پادکست است که در اندروید، آیفون و وب کار می کند. ثبت نام کنید تا اشتراک های شما در بین دستگاه های مختلف همگام سازی شود.