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

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 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.

[1]  G. A. Miller.  THE PSYCHOLOGICAL REVIEW THE MAGICAL NUMBER SEVEN, PLUS OR MINUS TWO: SOME LIMITS ON OUR CAPACITY FOR PROCESSING INFORMATION 1 , 1956 .

[2]  D. L. Parnas,et al.  On the criteria to be used in decomposing systems into modules , 1972, Software Pioneers.

[3]  F. P. Brooks,et al.  The mythical man-month" essays on software engineering, addison-wesley , 1974 .

[4]  Christopher Alexander,et al.  The Timeless Way of Building , 1979 .

[5]  W. Schneider,et al.  Deutsch für Profis : Wege zu gutem Stil , 1984 .

[6]  B. Marx.  The Visual Display of Quantitative Information , 1985 .

[7]  Tom DeMarco,et al.  Peopleware: Productive Projects and Teams , 1987 .

[8]  Susan T. Dumais,et al.  Textual Information Retrieval , 1988 .

[9]  Gerard Salton,et al.  Automatic Text Processing: The Transformation, Analysis, and Retrieval of Information by Computer , 1989 .

[10]  Kent Beck,et al.  A laboratory for teaching object oriented thinking , 1989, OOPSLA 1989.

[11]  Suzanne West.  Working with Style: Traditional and Modern Approaches to Layout and Typography , 1990 .

[12]  William Horton,et al.  Designing and writing online documentation , 1990 .

[13]  Ben Shneiderman,et al.  Structural analysis of hypertexts: identifying hierarchies and useful metrics , 1992, TOIS.

[14]  Multitrees: enriching and reusing hierarchical structure , 1994, CHI Conference Companion.

[15]  James O. Coplien,et al.  A generative development-process pattern language , 1995 .

[16]  Peter Sommerlad,et al.  Pattern-Oriented Software Architecture , 1996 .

[17]  Neil B. Harrison,et al.  Organizational patterns for teams , 1996 .

[18]  Robert Orenstein.  A pattern language for an essay-based Web site , 1996 .

[19]  David Flanagan,et al.  Java in a Nutshell , 1996 .

[20]  Charles Weir,et al.  Patterns for designing in teams , 1997 .

[21]  James O. Coplien.  A Pattern Language for Writers’ Workshops , 1997 .

[22]  Andreas Rüping.  Writing and Reviewing Technical Documents , 1998, EuroPLoP.

[23]  Andreas Rüping,et al.  The Structure and Layout of Technical Documents , 1998, EuroPLoP.

[24]  Alistair Cockburn,et al.  Surviving object-oriented projects: a manager's guide , 1998 .

[25]  Gerald M. Weinberg,et al.  Egoless Programming (Excerpt from the Psychology of Computer Programming, Silver Anniversary Edition). , 1998 .

[26]  Wn Holmes.  After 400 years, print is still superior , 1998 .

[27]  H. Margolis.  Visual explanations: Images and quantities, evidence and narrative , 1998 .

[28]  Andreas Rüping.  Typography and Desktop Publishing , 1999, EuroPLoP.

[29]  Andreas Rüping.  Project Documentation Management , 1999, EuroPLoP.

[30]  V. Dhar.  Customer Interaction Patterns in Electronic Commerce: Maximizing Information Liquidity for Adaptive Decision Making , 1999 .

[31]  S. Brand.  The Clock Of The Long Now: Time And Responsibility , 1999 .

[32]  S. Pinker.  How the Mind Works , 1999, Philosophy after Darwin.

[33]  Jakob Nielsen,et al.  Designing Web Usability: The Practice of Simplicity , 1999 .

[34]  Daniel Berleant.  Does typography affect proposal assessment , 2000 .

[35]  Larry Press.  From P-books to E-books. , 2000 .

[36]  Ken Schwaber,et al.  Agile Software Development with SCRUM , 2001 .

[37]  Norman L. Kerth,et al.  Project Retrospectives: A Handbook for Team Reviews , 2001 .

[38]  Markus Völter,et al.  Server Component Patterns - component infrastructures illustrated with EJB , 2002, Wiley series in software design patterns.

[39]  K. Beck,et al.  Extreme Programming Explained , 2002 .

[40]  Ron Jeffries,et al.  Agile Modeling: Effective Practices for eXtreme Programming and the Unified Process , 2002 .

[41]  Mary Lynn Manns,et al.  Fear Less - And other Patterns for Introducing New Ideas into Organizations , 2002, EuroPLoP.