Sangeetha-Grantha

Metadata Value
Status Active
Version 1.1.0
Last Updated 2026-09-10
Author Sangeetha Grantha Team
Document Type Decision record

ADR-001: Spec-Driven Documentation Architecture


[!NOTE] Decision record: preserve the original rationale and check its decision/supersession status. Current runtime guidance is in system architecture and Flyway migrations.

Context

Documentation was fragmented across module-level folders, duplicated PRDs, and ad-hoc notes that became stale. Engineers and stakeholders struggled to identify the canonical source of truth for product requirements, API contracts, database specs, and operational runbooks.

The proposal recommended consolidating documentation into a spec-driven structure under application_documentation/, backed by a central index and consistent front matter.

Decision

Adopt a spec-driven documentation architecture with:

Rationale

This structure provides:

Implementation Details

The documentation structure is organized as follows:

application_documentation/
├── 00-meta/              # Standards, retention plans, quick references
├── 01-requirements/      # PRDs, domain models, feature requirements
├── 02-architecture/      # System design, tech stack, ADRs, diagrams
├── 03-api/              # API contracts, integration specs
├── 04-database/         # Schema, migrations, audit logs
├── 05-frontend/         # UI specs for admin web and mobile
├── 06-backend/          # Backend patterns, security, mutation handlers
├── 07-quality/          # Test plans, coverage reports, quality metrics
├── 08-operations/       # Config, runbooks, operational procedures
├── 09-ai/               # AI integration docs, knowledge bases
└── archive/             # Legacy documentation with tombstones

Front Matter Format: All authoritative documents include front matter with:

Current Status: ✅ Implemented - The documentation structure is in place and actively maintained. All new documentation follows this structure, and legacy content has been archived.

Consequences

Positive

Negative

Neutral

Follow-up

References


Section index · Documentation home · Feature status