Architecture documentation for the DigitalSreeni Image Annotator project, following the arc42 template.
| # | Section | Description |
|---|---|---|
| 1 | Introduction and Goals | Overview, features, quality goals, stakeholders |
| 2 | Architecture Constraints | Technical, organizational, platform constraints |
| 3 | Context and Scope | (Not yet documented) |
| 4 | Solution Strategy | (Not yet documented) |
| 5 | Building Block View | System structure, components, data model |
| 6 | Runtime View | Key scenarios and workflows |
| 7 | Deployment View | (Not yet documented - desktop app) |
| 8 | Cross-cutting Concepts | Coordinate systems, conversions, common patterns |
| 9 | Architecture Decisions | Key ADRs and rationale |
| 10 | Quality Requirements | (Covered in section 1) |
| 11 | Risks and Technical Debt | Known issues, limitations, debt |
| 12 | Glossary | Terms, acronyms, data structures |
For Developers:
- New to the codebase? Start with Building Block View
- Understanding a workflow? See Runtime View
- Need to know coordinate systems? Check Cross-cutting Concepts
For Architects:
- Design rationale: Architecture Decisions
- Constraints: Architecture Constraints
- Technical debt: Risks and Technical Debt
For Everyone:
- Project overview: Introduction and Goals
- Platform compatibility: Architecture Constraints
- Terminology: Glossary
- CLAUDE.md — Quick reference guide for Claude Code (in repository root)
- README.md — User-facing documentation (in repository root)
When making changes to the codebase:
-
Update arc42 docs when architecture changes:
- Add/update ADRs in Architecture Decisions
- Update component descriptions in Building Block View
- Document new workflows in Runtime View
- Add new terms to Glossary
-
Keep CLAUDE.md lean — only quick reference info; point here for details.
-
Document constraints — add platform issues and known bugs to Risks and Technical Debt.
-
Explain decisions — significant architectural choices deserve ADRs in section 9.