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

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 out
• When communication face-to-face would be better than paper or online
• How to adapt the documentation process to the requirements of individual projects and build in change
• How to organise documents and make them easily accessible
• When to use diagrams rather than text
• How to choose the right tools and techniques
• How 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.

Table of Contents

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.