Development Phase

1 min read / /

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. There are a few different techniques for doing this. Often the documentation development lifecycle looks like this:

  • Development begins—documentation fiction writing begins
  • Development completes—documentation fiction verification begins
  • Documentation is reviewed

Writing Fiction

As the team begins building the product, you can also begin writing documentation fiction. Just like your favorite made up story, documentation fiction is your documentation for the final product as you imagine it will be. Because you have the epic, user stories, and acceptance criteria, you can write some very well informed fiction. That said, rapid change is part of agile, so be ready to revise the fiction as needed. As you write, add placeholders for content you're not yet sure about or images that can't yet be taken.

Verifying Fiction

When the part of the product you're working on is complete, you can read through your documentation fiction and verify it's accuracy. This is also the time to replace placeholders with content and add images of the completed product. And just like that, your made up documentation has become a final draft ready for review.

Review

The best content is written by the entire team. Once one team member has written content, it's best to have one or two other teammates review it. Generally, you'll want to evaluate two different things:

  • Grammar and style—Whether it's "who" or "whom", it's important that your content is written in a unified voice using proper grammar. Be sure to use a style guide, otherwise content written within an agile process won't feel right because each individual writer employs their own personal style.
  • Technical accuracy—Make sure what you wrote is true to life. This is best done by the person(s) who built the product functionality directly, since it should be fresh in their head.

Be sure to review new documentation as soon as it's written. Lagging behind with documentation can can lead to out-of-date information or misinformation because teams typically move quickly to the next task.
https://www.k15t.com/rock-the-docs/documentation-guide/agile-documentation-process/development-phase
www.k15t.com
CC-MAIN-2023-06
90136
application/http; msgtype=response
sha1:DF37EIOZNQM5UPIKLKTSR5E2VVBCUJBB
<urn:uuid:4ba98fe1-7c17-40c7-8a1c-39dfebadda62>
2023-02-07T01:39:49Z
87.230.15.13
text/html
sha1:TUNY6TNHZG6SREFIQ6LRLIDYD2EGQFM5
<urn:uuid:0c0516fa-b90f-4e6e-8dd8-328328ffbe95>
https://www.k15t.com/rock-the-docs/documentation-guide/agile-documentation-process/development-phase
response
<urn:uuid:81fae0c3-38f4-4ad7-a2eb-bf31ab0690b1>
isPartOf: CC-MAIN-2023-06
publisher: Common Crawl
description: Wide crawl of the web for January/February 2023
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-163
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.4-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/