Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects

Documentation is the castor oil of programming. Managers think it is good for programmers, and programmers hate it! Jerry Weinberg in Psychology of Computer Programming
Andreas Rüping sugars the pill by giving sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross–referenced, provides solutions to common problems. Straightforward advice will help you to judge:What details should be left in and what left outWhen communication face–to–face would be better than paper or onlineHow to adapt the documentation process to the requirements of individual projects and build in changeHow to organise documents and make them easily accessibleWhen to use diagrams rather than textHow to choose the right tools and techniquesHow documentation impacts the customer
Better than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real–world examples and utilises agile principles to provide an accessible, practical pattern–based guide which shows how to produce necessary and high quality documentation.

Spis treści:
Foreword.
Preface.
Acknowledgements.
Introduction.
Project Background.
1. Finding the Right Topics.
2. Structuring Individual Documents.
3. Layout and Typography.
4. Infrastructure and Technical Organisation.
5. Management and Quality Assurance.
Final Remarks.
Pattern Thumbnails.
Glossary.
References.
Index.


Nota biograficzna:
Andreas Rüping is a member of the patterns think–tank, Hillside Europe, and has acted as the chairman of several EuroPLoP Conferences. He has 12 years industry experience of software development, most recently as a software engineer and consultant at sd&m software design & management AG in Germany.

Okładka tylna:
Documentation is the castor oil of programming. Managers think it is good for programmers, and programmers hate it! Jerry Weinberg in Psychology of Computer Programming
Andreas Rüping sugars the pill by giving sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross–referenced, provides solutions to common problems. Straightforward advice will help you to judge:What details should be left in and what left outWhen communication face–to–face would be better than paper or onlineHow to adapt the documentation process to the requirements of individual projects and build in changeHow to organise documents and make them easily accessibleWhen to use diagrams rather than textHow to choose the right tools and techniquesHow documentation impacts the customer
Better than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real–world examples and utilises agile principles to provide an accessible, practical pattern–based guide which shows how to produce necessary and high quality documentation.