با برنامه Player FM !
پادکست هایی که ارزش شنیدن دارند
حمایت شده
Insider's advice on actions your tech writers can take to create quality API documentation
Manage episode 291782013 series 2922116
At the 7th API The Docs Virtual event Michelle Fredette, technical writer at New Relic and Chris Cowell, Oregon-based technical trainer and writer presented on the issues of onboarding writers with different knowledge gaps and how to solve them with 8 hours of training. Uwana Ikaiddi, Developer Documentation Manager at BigCommerce explained the significance of external and internal audience feedback, and gave guidance on how to improve API documentation by them. In the Q&A panel of the event, they reflect on their talks and provide further insights on:
- Do you also train your developers on how they can document for themselves?
- What would you recommend for people who want to change career-path from development to techwriting?
- Is there a need for anti-personas, i.e. people who aren't specifically the core audience of the API documentation but might need to consider when writing the docs?
- How to build trust with your internal audience?
- Can you speak to techniques who are getting collected external feedback to the appropriate writers on a large writing team?
- Does teaching developer students technical writing support a faster and more efficient on-boarding process in the long run?
58 قسمت
Manage episode 291782013 series 2922116
At the 7th API The Docs Virtual event Michelle Fredette, technical writer at New Relic and Chris Cowell, Oregon-based technical trainer and writer presented on the issues of onboarding writers with different knowledge gaps and how to solve them with 8 hours of training. Uwana Ikaiddi, Developer Documentation Manager at BigCommerce explained the significance of external and internal audience feedback, and gave guidance on how to improve API documentation by them. In the Q&A panel of the event, they reflect on their talks and provide further insights on:
- Do you also train your developers on how they can document for themselves?
- What would you recommend for people who want to change career-path from development to techwriting?
- Is there a need for anti-personas, i.e. people who aren't specifically the core audience of the API documentation but might need to consider when writing the docs?
- How to build trust with your internal audience?
- Can you speak to techniques who are getting collected external feedback to the appropriate writers on a large writing team?
- Does teaching developer students technical writing support a faster and more efficient on-boarding process in the long run?
58 قسمت
همه قسمت ها
×


1 Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes 43:21

1 From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend 50:38


1 Install ways to check on the overall health of the portal - Conversation with Rachel Lee Nabors 25:39



1 Docs anthropology, and how to make content useful for the future - conversation with Portia Burton 27:22


1 Fostering an API-first culture in a startup environment - Discussion with Alex Akimov and Helen Kosova 42:54


1 Unified documentation hubs versus documentation islands - Discussion with Christoph Weber and Kristof Van Tomme 41:00


1 Innersource and the meaning of collaboration - Interview with Daniel Izquierdo and Kristof Van Tomme 50:09


1 Docs-as-Code for better collaboration at Amadeus for Developers - Interview with Anna Tsolakou and Mathieu Pincovai 27:11



1 Interview with Anthony Sansone, staff technical writer at MongoDB - The importance of onboarding in techwriting 38:28

1 Interview with Marc Burgauer part 2 - Will social practices eat your change strategy for breakfast? 33:36

1 Interview with Marc Burgauer part 1 - Will social practices eat your change strategy for breakfast? 38:29

1 When is no news good news for a scheduling platform? - Interview with DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from Calendly 37:32


1 Confidence and Critical Thinking part 1: techwriting is life-long learning - Interview with Anthony Sansone, Senior Technical Writer at MongoDB 32:16

1 Building a DevRel Team - Interview with Lorna Mitchell, Head of Developer Relations at Aiven. 29:19


1 Getting into the tech industry through technical writing - Interview with Carolyn Stransky, Frontend Engineer at Bryter 31:48

1 A good design is not about how something looks, it's about how something works - Interview with Liam Gallagher and Jake Eastham from Barclays 32:45


1 Inclusion and Accessibility - some suggestions from fellow documentarians - Interview with Ilona Koren-Deutsch 34:39
به Player FM خوش آمدید!
Player FM در سراسر وب را برای یافتن پادکست های با کیفیت اسکن می کند تا همین الان لذت ببرید. این بهترین برنامه ی پادکست است که در اندروید، آیفون و وب کار می کند. ثبت نام کنید تا اشتراک های شما در بین دستگاه های مختلف همگام سازی شود.