Use Case : UC18 – Use and Maintain Developer Documentation

User roles

Role	Description
Developer	Uses and contributes to the documentation to perform tasks.
Team Lead	Reviews and ensures the documentation is accurate and updated.
New Contributor	Relies on documentation to understand and join development.
Technical Writer (optional)	Maintains structure, formatting, and clarity of docs.

Prerequisites / Conditions

The project exists and has a working codebase.
There is a platform or folder for documentation (e.g., GitLab Wiki, /docs folder).
Basic documentation already exists or needs to be created.
Developers have access and permission to edit the docs.

Use Case Diagram

Description of use case – Make Payment

Developer accesses the documentation to understand setup, tools, or conventions.
If the documentation is outdated or unclear, the developer proposes or directly makes updates.
Team Lead or peer developer reviews the changes (via MR or Wiki history).
Documentation is version-controlled and kept aligned with project changes.
A new developer uses the docs to set up the project and gives feedback.

Exceptions

ID	Description
E1	Developer cannot find relevant docs → Raise an issue or contact Team Lead
E2	Docs are outdated → Developer updates and submits for review
E3	New contributor is blocked by unclear steps → Logs issues/improvement notes
E4	Merge request with doc update fails review → Sent back for revision

Result

Documentation remains up-to-date and usable, enabling efficient onboarding and reducing developer dependency on verbal explanations or guesswork.

Use frequency

High – Documentation is consulted and updated regularly during development, onboarding, and feature work.

Additional information

Sources