Documentation in Agile header image
user-help

Documentation in Agile


author

Steffen Burzlaff


header_image

Rock_the_Docs_ShareImage.png


videoId



Learn the basics of creating documentation in any agile framework.

Rock_the_Docs_ShareImage.png

Agile Basics

There are several frameworks for agile work, but at their core, each one values:

  • Individuals and interactions

  • Working product increments

  • Collaborating with customers

  • Responding quickly to change

Read the  Agile Manifesto that started it all and learn more about  agile.

Where Documentation Fits

Generally, agile is great; but it's important to understand what it means for documentation specifically. Especially since the Agile Manifesto states that "extensive documentation" is not as highly valued as working product increments.

The key to agile documentation is understanding how to minimize the creation of documentation as the product is designed and built and how to reuse that content to create the final documentation. In the end, there should be a set of up-to-date documentation about what the product actually does rather than a paper trail of project documentation about what the team thought it would do.

Let's walk through each phase of the agile process and see how documentation fits in. Consider the agile framework your team uses and think about how and where to apply these tips. Remember, there isn't one way to do agile. The only qualifier is that your team values the agile principles above.

See also: Tom Johnson's thoughts on  following Scrum with documentation projects.


Embed comments

Read on..

This is when your team documents what users want and how you plan to deliver it within the product. Use this phase as an opportunity to begin your draft documentation.

user-help
Steffen Burzlaff Steffen Burzlaff

With your draft in hand, you'll begin working with the team to write full documentation. This phase is interesting, because the team is simultaneously building and documenting the product.

user-help
Steffen Burzlaff Steffen Burzlaff

Test the quality of your documentation by having one or more people unfamiliar with the contents read it and provide feedback.

user-help
Steffen Burzlaff Steffen Burzlaff
user-help
Testing Phase

As part of a great agile process, your documentation is ready for delivery along with your product. Publishing can be handled using one or more approaches, depending on the type of product you make.

user-help
Steffen Burzlaff Steffen Burzlaff

With the product and documentation in the hands of customers, you will continue to review and iterate to improve your content.

user-help
Steffen Burzlaff Steffen Burzlaff
Share this article
Reset Cookies

The following services will be reset and deactivated for you.

  • Typeform:
    We're using Typeform to embed quizzes and surveys into our website. By clicking "Disable all services" you're no longer able to submit quizzes or surveys on our website until accepting the service again.
  • Hyvor Talk:
    We're using Hyvor Talk as a comment tool. Hyvor Talk sets a local storage when activated. By clicking "Disable all services" you're no longer able to post or read comments on our website until accepting the service again.

By clicking "Disable all services" all cookies and local storages related to the services will be removed. Before using them on our website again, you need to accept them.