chore: condense all docs and markdown files

This commit is contained in:
2026-03-14 15:11:40 +03:00
parent f3811b7520
commit 8b626a940e
24 changed files with 483 additions and 1346 deletions
+15 -47
View File
@@ -1,51 +1,19 @@
# Documentation Practices
These standards aim to keep documentation reliable as the codebase grows.
# Documentation Rules
## Principles
- Single source of truth per topic; link, do not duplicate.
- Update docs in same change set as code.
- Prefer observable behavior (what to run, what to see).
- Single source of truth: one canonical doc per topic; link instead of duplicating.
- Proximity: keep docs close to the code they describe when possible.
- Freshness: update docs in the same PR as the code change.
- Observable behavior: describe what someone can see or run to validate the behavior.
## Canonical Locations
- Architecture/system boundaries: `docs/architecture.md`
- Execution plans: `docs/execplans/` + policy in `docs/PLANS.md`
- Operational procedures: `docs/runbooks/`
- Cross-cutting decisions: `docs/adr/`
- Known gaps: `docs/risks.md`
## Required Docs By Area
- Architecture and major decisions: `docs/architecture.md` and `docs/adr/`.
- Feature delivery plans: `docs/execplans/` (required by `PLANS.md`).
- Operational procedures: `docs/runbooks/`.
- Risks and gaps: `docs/risks.md`.
## When To Write An ADR
Use an ADR for any decision that is cross-cutting or hard to reverse, including:
- External providers or payment/auth strategy changes.
- Async vs synchronous execution decisions.
- Data model changes that affect multiple apps or services.
ADRs live in `docs/adr/` and use the template in `docs/templates/adr.md`.
## Runbook Expectations
Every production-impacting flow should have a runbook that covers:
- Symptoms and impact.
- Detection and quick checks.
- Safe remediation steps.
- Rollback or escalation path.
Use the template in `docs/templates/runbook.md`.
## Writing Style
- Be explicit: include exact commands, paths, and expected output where useful.
- Keep sections short and focused.
- Avoid unstated assumptions; if a step needs a specific directory, say so.
## Review Checklist
- Docs updated or explicitly confirmed unnecessary.
- New runbook added when operational behavior changes.
- ADR added for new cross-cutting decisions.
- `docs/risks.md` updated for meaningful gaps added or closed.
## Minimum Review Checklist
- Docs touched or explicitly unchanged.
- Runbook updated for production-impacting flow changes.
- ADR added when decision is hard to reverse.
- Risks updated when a major gap opens/closes.