Invest in the creation of a document relative to the amount of its readers and the estimated time they will save searching for the information. Also take into account that a clear text reduces the risk of misunderstanding.

An author needs to know the amount of resources to invest into creating a document. The stakeholder who has interest in the document to be created may know how much to spent. But is there an amount of time that is "just right"?

How can stakeholders determine how much resources should be invested in creating a document?

Structure

There is a basic cost that is dependent on the information to be written about. It depends on the author's skill in technical writing how long this will take. There is no hard-and-fast rule to determine the required resources.

But after the main body of the text is in place, the amount for future work on refining and editing this text can be estimated. Assume the number of readers of the document and estimate the amount of time each reader may save by adding extra time in refining the text. This provides the break-even point of work to add additionally to the creation of the document.

Also do not forget that a clear text supports readers to get the information right in first place.

Stakeholders should usually bring that information into a written form that imposes the greatest risk for the success of the project when lost. If there are multiple documents to be written on the same risk level, those whose audience is larger should be preferred to write.

Advantages

  • Agility is also about time boxes. To determine the right size of the box helps the team to plan their work and get the job done in time and in budget.

Disadvantages

  • There is an extra time to invest into figuring out the numbers. Typically this is only a guess that may be far from the real numbers.

Related Practices

The following practices are related to this practice.

Provide multiple Views
Provide views on your topic-based documentation.
Dynamic Links
Build a navigation to related and associated information by the use of document properties and dynamic linking.
Use Templates
Define a basic structure for all artifacts of a given type. Readers will have an easier job on finding and learning about the information in your documentation.