Skip to content

README.md

Latest commit

 

History

History
86 lines (79 loc) · 3.76 KB

README.md

File metadata and controls

86 lines (79 loc) · 3.76 KB

Documentation

This directory is the source of truth for documentation in this repository.

Directory Structure

/docs
├── README.md
├── AGENTS.md
├── PRD.md
├── system-design.md
├── ai/
│   ├── README.md
│   └── {area}/...
├── templates/
│   ├── adr.md
│   ├── feature-spec.md
│   ├── PRD.md
│   ├── system-design.md
│   └── ...
├── rules/
│   ├── AGENTS.md
│   ├── README.md
│   ├── common/
│   │   ├── AGENTS.md
│   │   ├── README.md
│   │   ├── coding-style.md
│   │   ├── security.md
│   │   ├── git-workflow.md
│   │   ├── patterns.md
│   │   ├── testing.md
│   │   └── ...
│   ├── typescript/
│   │   └── ...
│   ├── rust/
│   │   └── ...
│   └── {framework}/
│       └── ...
├── adrs/
│   ├── AGENTS.md
│   ├── README.md
│   ├── 0001-initial-architecture-decision.md
│   └── ...
├── specs/
│   ├── AGENTS.md
│   ├── README.md
│   ├── 0001-user-authentication/
│   │   ├── spec.md
│   │   └── ...
│   └── ...
├── knowledge/
│   ├── AGENTS.md
│   ├── README.md
│   └── ...
├── guides/
│   ├── AGENTS.md
│   ├── README.md
│   └── ...
├── reference/
│   ├── AGENTS.md
│   ├── README.md
│   ├── sdl-phases.md
│   └── ...
└── ...
  • adrs/ (Required) — Architecture Decision Records. System-wide decisions that affect multiple features (e.g. framework choices, infrastructure, protocols). See docs/adrs/README.md for structure and conventions.
  • specs/ (Required) — Feature specifications. One folder per feature. spec.md is required as the entry point. See docs/specs/README.md for structure and conventions.
  • rules/ (Recommended) — Coding rules, standards, conventions, and practices: code style, git workflow, testing, development practices, etc. See docs/rules/README.md for structure and conventions.
  • PRD.md (Recommended) — Product requirements: problem, success criteria, user needs, scope. Upstream of system design and feature specs.
  • system-design.md (Recommended) — High-level system architecture: tech stack, service connections, infrastructure layout, external dependencies, etc.
  • ai/ (Recommended) — Hierarchical, AI-navigable docs that point to the right source files for each topic. See cmk:codebase-docs for the structure and conventions.
  • knowledge/ (Recommended) — Accumulated knowledge: gotchas, non-obvious findings, hard-won insights. One file per topic. See docs/knowledge/README.md for structure and conventions.
  • guides/ (Recommended) — Operational and onboarding docs, team decides what's needed (e.g. onboarding.md, local-dev.md, deployment.md).
  • reference/ (Recommended) — Cross-cutting reference docs shared across phases and teams. See docs/reference/README.md for structure and conventions.
  • AGENTS.md — Agent navigation instructions for this docs subtree.

Recommended Templates

Note: Engineers can add more files or folders as needed. This structure is a baseline, not a restriction.