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.

Activities

Name Responsible Description

Receive and assess documentation feedback

Services

The services department can receive feedback on documentation. This can come from several sources.

Sources are, for example:
  • Customer
  • Partner
  • Internal (STAEDEAN service or support colleagues)
  • Bug solution (Code changes to solve a bug can require a documentation change)
The service department assesses the feedback, and if a documentation change is required, informs the technical writer.

Do triage of documentation feedback and estimate work

Technical writer

The technical writer can receive feedback on documentation from the service department.

Feedback on documentation can come from several sources, for example:

  • Customer
  • Partner
  • Internal (STAEDEAN service or support colleagues)
  • Bug solution (Code changes to solve a bug can require a documentation change)
The technical writer assesses the feedback.
If a documentation change is required, the technical writer creates a DevOps task with description and estimated time of the required work in number of hours.
The documentation task is added to the appropriate product increment PBI.

Activities

Name Responsible Description

Receive and assess documentation feedback

Services

The services department can receive feedback on documentation. This can come from several sources.

Sources are, for example:
  • Customer
  • Partner
  • Internal (STAEDEAN service or support colleagues)
  • Bug solution (Code changes to solve a bug can require a documentation change)
The service department assesses the feedback, and if a documentation change is required, informs the technical writer.

Do triage of documentation feedback and estimate work

Technical writer

The technical writer can receive feedback on documentation from the service department.

Feedback on documentation can come from several sources, for example:

  • Customer
  • Partner
  • Internal (STAEDEAN service or support colleagues)
  • Bug solution (Code changes to solve a bug can require a documentation change)
The technical writer assesses the feedback.
If a documentation change is required, the technical writer creates a DevOps task with description and estimated time of the required work in number of hours.
The documentation task is added to the appropriate product increment PBI.