Boost Your API with Effective Documentation Strategies
summary
Company recommits to developer documentation by hiring a small docs team, stopping a year-long “free fall,” then running three months of reactive fixes before shifting to proactive work tied into the SDLC. The team relaunches an interactive onboarding flow in the dashboard a month ago, restores changelogs that sales actually use, turns docs SEO from net negative to net positive in three months, and experiments with GitHub Copilot for docs and open API spec into ChatGPT to generate starter guides.
AI-written summary · about
chapters (12)
- 0:00Intro
- 4:15Current State of Documentation
- 5:36Identifying Allies and Helpers
- 7:28Gaining Leadership Support
- 9:16Advocating for a Docs Team
- 11:51Orchestrating Improvement
- 15:54Enhancing Documentation Quality
- 19:00Optimizing Onboarding Journeys
- 21:26Future Steps in Documentation
- 23:25Key Takeaways
- 25:04Documentation Resources
- 26:27Join Our Team
related talks
24mDocs for Developers: How to start when everything is hard
35mDev Experience in Technical Writing: 15 Tips to Boost Developer Satisfaction
29mThe Power of Ecosystem Thinking: Cultivating AsyncAPI Docs Community
14mDeveloper Experience: Your documentation deserves more love!
27mThe hidden power of information assets The role of documentation in product success
19mStreamlining API Documentation: Proven DocOps Strategies
35mDocumenting APIs: new era, same craft
44mUseful and Beautiful Developer Docs and How to Create Them