Docs-as-Ecosystem: The Community Approach to Engineering Documentation (1st ed.)

By:

Sign Up Now! Already a Member? Log In
You must be logged into Bookshare to access this title. Learn about membership options, or view our freely available titles.

Synopsis
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,
Copyright:
2023

Book Details

Book Quality:
Publisher Quality
ISBN-13:
9781484293287
Related ISBNs:
9781484293270
Publisher:
Apress
Date of Addition:
Copyrighted By:
Alejandra Quetzalli
Adult content:
No
Language:
English
Has Image Descriptions:
No
Categories:
Nonfiction, Computers and Internet
Submitted By:
Bookshare Staff
Usage Restrictions:
This is a copyrighted book.

Reviews

No Rating Yet