Skip to content

documentation

When a future maintainer wants to update or fix features created by this team, they want to have good documentation to help them understand what has been done to make a feature.

Author: Arttu Hiekkanen

Date / Version: 16.02.2024

User roles

  • Future developer

Prerequisites / Conditions

  • Feature created
  • Future developer wants to update/ fix a feature

Description of use case

  1. A future developer sets up tukko
  2. they find a bug
  3. they go find the documentation to help understand what and how the feature works

Result

The future developer will be able to work a lot faster and more efficiently.

Use frequency

Rarely, depends on the amount of future developement the software will have.

Sources

This wiki-document is based on the The public administration recommendations

Thanks to the original authors.