Documentation work can come from several sources:
  • New development
  • Documentation backlog
  • Documentation feedback
In STAEDEAN, we use Azure DevOps to manage and monitor the development work to be done. This includes the product documentation work. So, the work breakdown structure for the documentation work to be done must be set up in DevOps. How it is added in DevOps depends on the source of the documentation work.
The main goals of this process are to:
  • Get a better insight in the documentation work to be done.
  • Prevent from incorrect and incomplete documentation.


Product manager Product manager Product owner Product owner Technical writer Technical writer Start Start Create documentation epic and features Create documentation epic and features For each pillar/domain, the software development is managed in a separate DevOps project. The product owner provides: A documentation epic for each pillar/domain. In this epic, a documentation feature for each of the pillar/domain products. Create and estimate documentation work breakdown Create and estimate documentation work breakdown For each product increment, the technical writer creates a separate product backlog item. For each product backlog item, the technical writer creates the related work breakdown structure and estimates for the documentation work. So, the documentation work can be scheduled/picked up in the sprints of the related product team. The product increment document work breakdown is created: Based on the product increment release notes. In consultation with the product owner where needed. To set up documentation tasks in DevOps, it is best practice to: Copy release note section content to the related task. Add a textual reference to the related release notes section. If already clear, make notes on what must be done/changed/added to the documentation and where this must be done in the documentation. Of course, both the Budget (which is the estimate) and Remaining hours must be entered. On estimations, these two values must be the same. Prioritize overall documentation backlog Prioritize overall documentation backlog Product management, in consultation with technical writers and product owners, prioritizes the overall documentation work. Usually, prioritizing the documentation work is done once per product increment. Preferably, prioritizing is done before or early in the product increment. End End Add documentation feedback work to DevOps

Add documentation feedback work to DevOps

Documentation feedback can come from several source. We must make sure to take care of documentation feedback. And if changes are required, we must make sure these changes are actually made to the documentation.

To manage the documentation feedback, actions are required from several departments.

What's the origin of the  documentation work? What's the origin of the  documentation work? Development Feedback

Activities

Name Responsible Description

Create documentation epic and features

Product owner

For each pillar/domain, the software development is managed in a separate DevOps project.
The product owner provides:

  • A documentation epic for each pillar/domain.
  • In this epic, a documentation feature for each of the pillar/domain products.

Create and estimate documentation work breakdown

Technical writer

For each product increment, the technical writer creates a separate product backlog item.

For each product backlog item, the technical writer creates the related work breakdown structure and estimates for the documentation work. So, the documentation work can be scheduled/picked up in the sprints of the related product team.

The product increment document work breakdown is created:

  • Based on the product increment release notes.
  • In consultation with the product owner where needed.

To set up documentation tasks in DevOps, it is best practice to:

  • Copy release note section content to the related task.
  • Add a textual reference to the related release notes section.
  • If already clear, make notes on what must be done/changed/added to the documentation and where this must be done in the documentation.

Of course, both the Budget (which is the estimate) and Remaining hours must be entered. On estimations, these two values must be the same.

Prioritize overall documentation backlog

Product manager

Product management, in consultation with technical writers and product owners, prioritizes the overall documentation work.

Usually, prioritizing the documentation work is done once per product increment. Preferably, prioritizing is done before or early in the product increment.

Add documentation feedback work to DevOps

Technical writer

Documentation feedback can come from several source. We must make sure to take care of documentation feedback. And if changes are required, we must make sure these changes are actually made to the documentation.
To manage the documentation feedback, actions are required from several departments.