DOCS ECOSYSTEM BOOK BY QUETZALLI
ISBN-13: 9781484293270
ISBN-10: 1484293274
Category: Software Management
Publisher: Apress
Publication Date: September 11th, 2023
Language: English
Investing in engineering documentation (Docs) means investing in community user experience. This book teaches how mastering the proposed docs-as-ecosystem model empowers communities to understand better their favorite products and Open-Source (OSS) technologies.
Quetzalli believes that "docs-as-ecosystem" represents a more comprehensive and collaborative approach to documentation development than "docs-as-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 documentation is treated 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.
EARNED DUAL #1 NEW RELEASE TITLES ON AMAZON!
Quetzalli’s docs ecosystem book has been recognized as the #1 new release in two categories on Amazon: Software Design & Engineering and Software Testing.
WHAT’S IN THE BOOK?
Preface: Why docs-as-ecosystem?
Chapter 1: Accessibility
Chapter 2: Information Architecture
Chapter 3: SEO
Chapter 4: Design and UX
Chapter 5: Documenting APIs
Chapter 6: Documenting SDKs
Chapter 7: Integrating Docs into CI/CD Pipelines
Chapter 8: Creating a Docs Style Guide
Chapter 9: Managing Open-Source Contributions
Chapter 10: Retrieve Community Feedback and Analytics
Chapter 11: Prioritize Docs Requests
Chapter 12: Open Community Communication Channels
Chapter 13: Managing Technical Writers
Chapter 14: The Future of ChatGPT and AI in Docs
Appendix A: Engineering Docs Templates
References
Acknowledgments