[USER-STORY] Maintainer - Architecture Documentation

[jody]

User Story

Recognized stakeholder types: Decision-Maker, Maintainer

Story

As a Maintainer

I want documentation of the software architecture of the product

so that I can quickly gain an overview of the software design and locate where to make changes.

Acceptance Criteria

Rules

1. 1. Software Architecture (SWA) documentation exists in the repository (PR User story #120 contribution #125 )
2. 2. SWA documentation is linked from/to appropriate Maintainer documents
3. 3. The SWA documentation includes representation of modules (e.g. classes) and their relationships
4. 4. The SWA documentation self-explains how the documentation is maintained

Supporting Information

[Relevant information, context, resources, references]
Consider a simpler approach: using Javadoc to dynamically generate API documentation for the project.

Documenting Software Architectures in an Agile World
A minimal approach to software architecture documentation

Documenting Agile Architecture: Practices and Recommendations (research paper)

Dependencies

Depends On

[Links to other issues on which this story depends]

Dependents

[Links to other issues that depend on this story]

[jody]

Now awaiting PRs or User Stories to address Rules 2-4