Docs-as-Ecosystem: The Community Approach to Engineering Documentation

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, yoü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. Yoüll learn to identify the difference in work processes between maintaining Docs for a product versus an OSS technology. Yoüll discover the secrets to managing technical writers and OSS contributions, all while building a thriving Docs community. To end on a futuristic note, yoüll discover why technical writers who harness Artificial Intelligence (AI) tools (i.e., ChatGPT) need not fear a robot uprising anytime soon.