Every significant technical article should contain, where possible #
- Status:
Current/Deprecated/Historical - Last verified: date the content was last checked against code/production
- Source file: path in Git, if the article mirrors a file
- Related code: modules, classes, endpoints
- Related Git commit / release
- Purpose
- How it works
- Important business rules
- Known limitations
Metadata header #
Start technical articles with a header block like:
Status: Current
Last verified: YYYY-MM-DD
Source: Git
Source file: docs/EXAMPLE.md
Git commit: <sha>Which document is which #
| Document | Answers |
|---|---|
| Production Changelog | What changed on production, and in which deployed commit. |
| Wiki article | How the system works now. |
| Git Markdown | The technical source of truth, kept next to the code. |
| Agent Reference | Short, exact information an AI/agent must read before changing a subsystem. |
Statuses #
- Current — describes the system as it runs on production.
- Deprecated — no longer accurate; kept with a pointer to the replacement.
- Historical — intentionally preserved record (investigations, past decisions).
Never silently overwrite an article with information that has not been verified. When unsure, mark it Deprecated or leave Last verified at the old date.
Language #
The main Wiki language is Russian; every article should, where possible, have an English version linked as its translation. Technical identifiers and application UI labels are not translated.