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) technolo
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 LearnExamine accessibility and the user experienceUnderstand Information architecture Review docs-as-ecosystem processes Manage technical writersOversee OSS Docs contributions Retrieve and integrate user feedback Build Docs and Education communities Who This Book is ForDevelopers of all levels, VPs of Product/Engineering, Product Managers, and Designers,
Our site uses cookies and similar technologies to offer you a better experience. We use analytical cookies (our own and third party) to understand and improve your browsing experience, and advertising cookies (our own and third party) to send you advertisements in line with your preferences. To modify or opt-out of the use of some or all of our cookies, please go to “Manage Cookies” or view our Cookie Policy to find out more. By clicking “Accept all” you consent to the use of these cookies.