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

eBook Details:

  • Paperback: 268 pages
  • Publisher: WOW! eBook (August 9, 2023)
  • Language: English
  • ISBN-10: 1484293274
  • ISBN-13: 978-1484293270

eBook Description:

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.

  • 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

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.

Recovery Closure Enhancing Zipped Up Bandage Patch


Leave a Reply

Your email address will not be published. Required fields are marked *