Docs for Developers An Engineer’s Field Guide to Technical Writing

Learn to integrate programming with good documentation. This book teaches you the craft of documentation for each step in the software development lifecycle, from understanding your users’ needs to publishing, measuring, and maintaining useful developer documentation. Well-documented projects save t...

Descripción completa

Detalles Bibliográficos
Otros Autores: Bhatti, Jared, author (author), Hightower, Kelsey, writer of foreword (writer of foreword)
Formato: Libro electrónico
Idioma:Inglés
Publicado: Berkeley, CA : Apress 2021.
Edición:1st ed. 2021.
Materias:
Ver en Biblioteca Universitat Ramon Llull:https://discovery.url.edu/permalink/34CSUC_URL/1im36ta/alma991009634690306719
Tabla de Contenidos:
  • 1. Getting Started
  • 2. Researching Documentation
  • 3. Designing Documentation
  • 4. Drafting Documentation
  • 5. Structuring Sets of Documentation
  • 6. Integrating Code Samples and Visual Content
  • 7. Measuring Documentation Success
  • 8. Working With Contributors
  • 9. Maintaining Documentation
  • 10. Wrapping Up.