Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process
Section
Column
Document Properties Marker
overridefalse
Short DescriptionAgile documentation is not another buzzword. There is actually a set of rules to follow which will lead to meaningful documentation. Writing helpful documentation is not easy, but it gets a lot easier with the agile mindset - and with the projectdoc Toolbox.
Doctypetopichide
NameAgile Documentation
Parent
Parent Property
propertyParent
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Documentation Gardener, Author, Template Author
propertyAudience
empty-as-nonefalse

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesAdvanced Beginner
propertyLevel of Experience
empty-as-nonefalse

Expected Duration20 min
Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
render-list-as-comma-separated-valuestrue
namesagile, documentation, wiki, Confluence, projectdoc Toolbox, projectdoc, transclusion, dynamic list, autolist, space properties, metadata
propertyTags


Iteration
Iteration
valuefilled
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType

Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide
Section
show-titlefalse
titleDescription

Effective communication is an essential part for the success of a software development project. Documentation is that part of the communication that needs to be written down. There are several reasons for writing things down.

  1. Scaling - feeding with information in parallel
  2. Communication for dislocated teams (in space and time)
  3. Communication with one's future self (journals)
  4. Support learning at an individual pace
  5. Learn more about the subject by having to put it in words

Writing is not an easy task.

Quote External
authorWilliam Zinsser
author-urihttp://www.williamzinsserwriter.com/
sourceOn Writing Well

Writing is hard work. A clear sentence is no accident. Very few sentences come out right the first time, or even the third time. Remember this as a consolation in moments of despair. If you find that writing is hard, it's because it is hard. It's one of the hardest things that people do.

Documentation of a software project is communicating important facts. Reasons for decisions, the quality goals, the requirements, the architecture, all this (and more) typically needs to be communicated. This could be overwhelming to create and a nightmare to maintain.

Agile documentation for the rescue!

Column
width300px
Panel
titleContents

Table of Contents
outlinetrue
indent10px
excludeAgile Documentation
stylenone
 

Panel
borderColorDarkred
bgColorlightred
titleColorwhite
titleBGColorDarkred
titleAgile

This article does not discuss or explain basic agile values, principles or techniques. It assumes that the reader is familiar with this approach.

If you want to learn about agile, we recommend to start by reading the Agile Manifesto.

...