Docs-as-Ecosystem
The Community Approach to Engineering Documentation
- English
- ePUB (mobile friendly)
- Available on iOS & Android
About This Book
Investing in engineering documentation (Docs) means investing in community user experience. This book teaches readers how mastering the docs-as-code ecosystem empowers communities to understand better their favorite products and Open-Source (OSS) technologies better.
Author Alejandra Quetzalli believes that "docs-as-ecosystem" represents a more comprehensive and collaborative approach to documentation development than "docsas- code" because it recognizes that documentation is more than just code. Docs involve technical writing, design, community feedback, community management, accessibility, SEO, UX, and today⌠even Artificial Intelligence tools! The word ecosystem promotes a paradigm where we treat documentation as a complex and dynamic system that must be managed and nurtured.
In this book, you'll acquire practical skills such as creating public style guides, incorporating responsive and accessible design, designing user flows and information architecture, retrieving user feedback, and setting up Docs analytics. You'll learn to identify the difference in work processes between maintaining Docs for a product versus an OSS technology. You'll discover the secrets to managing technical writers and OSS contributions, all while building a thriving Docs community. To end on a futuristic note, you'll discover why technical writers who harness Artificial Intelligence (AI) tools (i.e., ChatGPT) need not fear a robot uprising anytime soon.
What You'll Learn
- Examine accessibility and the user experience
- Understand Information architecture
- Review docs-as-ecosystem processes
- Manage technical writers
- Oversee OSS Docs contributions
- Retrieve and integrate user feedback
- Build Docs and Education communities
Who This Book is For
Developers of all levels, VPs of Product/Engineering, Product Managers, and Designers,
Frequently asked questions
Information
Table of contents
- Cover
- Front Matter
- 1. Accessibility
- 2. Information Architecture
- 3. Search Engine Optimization
- 4. User Interface and User Experience
- 5. Documenting APIs
- 6. Documenting SDKs
- 7. Integrating Docs into CI/CD Pipelines
- 8. Crafting Public Style Guides
- 9. Managing OSS Docs Contributions
- 10. Retrieve Community Feedback and Analytics
- 11. Prioritize Documentation Requests
- 12. Open Community Communication Channels
- 13. Managing Technical Writers
- 14. The Future of ChatGPT and AI in Docs
- Back Matter