Docs-as-Ecosystem: The Community Approach to Engineering Documentation
Docs-as-Ecosystem: The Community Approach to Engineering Documentation
YOU SAVE £5.68
- Condition: Brand new
- UK Delivery times: Usually arrives within 2 - 3 working days
- UK Shipping: Fee starts at £2.39. Subject to product weight & dimension
- More about Docs-as-Ecosystem: The Community Approach to Engineering Documentation
Investing in engineering documentation (Docs) is essential for improving the community user experience. This book teaches readers how to master the docs-as-code ecosystem, which recognizes that documentation is more than just code and involves technical writing, design, community feedback, community management, accessibility, SEO, UX, and AI tools. It provides practical skills for creating public style guides, incorporating responsive and accessible design, designing user flows and information architecture, retrieving user feedback, and setting up Docs analytics. It also discusses the difference between maintaining Docs for a product and an OSS technology and the secrets to managing technical writers and OSS contributions. Finally, it suggests that technical writers who harness AI tools should not fear a robot uprising.
Format: Paperback / softback
Length: 242 pages
Publication date: 09 August 2023
Publisher: APress
Investing in engineering documentation (Docs) is not just about creating technical documents; it's about enhancing the community user experience. This book aims to empower communities to gain a deeper understanding of their favorite products and Open-Source (OSS) technologies by teaching them how to leverage the docs-as-code ecosystem.
Author Alejandra 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 goes beyond just code. Docs encompass a wide range of activities, including technical writing, design, community feedback, community management, accessibility, search engine optimization (SEO), user experience (UX), and even Artificial Intelligence (AI) tools.
The ecosystem approach promotes a mindset where documentation is treated as a complex and dynamic system that requires management and nurturing. In this book, readers will acquire practical skills for creating public style guides, incorporating responsive and accessible design, designing user flows and information architecture, retrieving user feedback, and setting up Docs analytics. They will learn to differentiate between maintaining Docs for a product versus an OSS technology and discover the secrets to managing technical writers and OSS contributions. Additionally, they will explore the future of technical writing, where AI tools like ChatGPT can be leveraged to enhance the productivity and efficiency of technical writers.
Who This Book is For:
Developers of all levels, VPs of Product, and anyone interested in improving the quality and effectiveness of engineering documentation.
Weight: 526g
Dimension: 177 x 254 x 18 (mm)
ISBN-13: 9781484293270
Edition number: 1st ed.
This item can be found in:
UK and International shipping information
UK and International shipping information
UK Delivery and returns information:
- Delivery within 2 - 3 days when ordering in the UK.
- Shipping fee for UK customers from £2.39. Fully tracked shipping service available.
- Returns policy: Return within 30 days of receipt for full refund.
International deliveries:
Shulph Ink now ships to Australia, Belgium, Canada, France, Germany, Ireland, Italy, India, Luxembourg Saudi Arabia, Singapore, Spain, Netherlands, New Zealand, United Arab Emirates, United States of America.
- Delivery times: within 5 - 10 days for international orders.
- Shipping fee: charges vary for overseas orders. Only tracked services are available for most international orders. Some countries have untracked shipping options.
- Customs charges: If ordering to addresses outside the United Kingdom, you may or may not incur additional customs and duties fees during local delivery.