Description
Book SynopsisInvesting 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, an
Table of ContentsDesigning Developer Documentation as a ProductChapter 1 - Accessibility
Chapter 2 - Information Architecture
Chapter 3 - SEO
Chapter 4 - UI Design
Chapter 5 - Documenting APIs
Chapter 6 - Documenting SDKs
Chapter 7 - Integrating your Docs into CI/CD pipelines
Chapter 8 - Make your style guide public
Chapter 9 - Open Source contributions
Chapter 10 - Retrieve customer feedback and analytics
Chapter 11 - Prioritize documentation requests
Chapter 12 - Open community communication channels
Appendix A: Engineering Documentation Templates
References
