Docs-as-Ecosystem : The Community Approach to Engineering Documentation / / by Alejandra Quetzalli
(Visualizza in formato marc)
(Visualizza in BIBFRAME)
| Autore: |
Quetzalli Alejandra
|
| Titolo: |
Docs-as-Ecosystem : The Community Approach to Engineering Documentation / / by Alejandra Quetzalli
|
| Pubblicazione: | Berkeley, CA : , : Apress : , : Imprint : Apress, , 2023 |
| Edizione: | 1st ed. 2023. |
| Descrizione fisica: | 1 online resource (XXVI, 242 p. 138 illus., 136 illus. in color.) |
| Disciplina: | 929.605 |
| Soggetto topico: | Internet programming |
| Computer programming | |
| Computer programs - Testing | |
| Software engineering - Management | |
| Open source software | |
| Web Development | |
| Programming Techniques | |
| Software Testing | |
| Software Management | |
| Open Source | |
| Note generali: | Includes index. |
| Nota di contenuto: | Chapter 1: Accessibility -- Chapter 2: Information Architecture -- Chapter 3: SEO -- Chapter 4: UI Design -- Chapter 5: Documenting APIs -- Chapter 6: Documenting SDKs -- Chapter 7: Integrating your Docs into CI/CD pipelines -- Chapter 8: Make your style guide public -- Chapter 9: Open Source contributions -- Chapter 10: Retrieve customer feedback and analytics -- Chapter 11: Prioritize documentation requests -- Chapter 12: Open community communication channels -- Chapter 13 - ChatGPT and AI -- Appendix A: Engineering Documentation Templates. |
| Sommario/riassunto: | 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. . |
| Titolo autorizzato: | Docs-as-Ecosystem |
| ISBN: | 9781484293287 |
| 1484293282 | |
| Formato: | Materiale a stampa  |
| Livello bibliografico | Monografia |
| Lingua di pubblicazione: | Inglese |
| Record Nr.: | 9910741136903321 |
| Lo trovi qui: | Univ. Federico II |
| Opac: | Controlla la disponibilità qui |