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

by Andreas Rüping

Software documentation forms the basis for all communication relating to a software project. To be truly effective and usable, it should be based on what needs to be known. Agile Documentation provides 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 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.

256 pages, Paperback

First published September 11, 2003

Reviews

[Nente · Rating 3 out of 5]

As this book makes clear on the first couple of pages, it deals primarily with internal project documentation, not the documentation written by technical writers and delivered to the final users. So I looked it through more than read from cover to cover, and it is structured in a way that makes it very easy to do that. Many of the patterns seem obvious, but sometimes you do need to state the obvious, if only as a discussion starter.
Final verdict: not indispensable, but potentially useful if your project documentation is a pain.

[Magnus · Rating 2 out of 5]

A discussion how to document your projects with focus on Agile projects which means ==> "working software over comprehensive documentation"

I feel the book doesnt have any magic solutions but it is some nice reading and good to reflect how to document in the best way.