Documentation Map
Это перевод английского документа
docs/documentation-map.md. Английская версия является source of truth. Если перевод противоречит английскому документу, английский документ имеет приоритет.
Этот документ является индексом документации проекта. Он фиксирует purpose, tier, status, translation status и when to update.
Английская документация — source of truth. Русские файлы в docs/ru/ являются только переводами и не вводят самостоятельных архитектурных решений.
Status Values
existing— документ существует в repository.planned— документ запланирован, но ещё не создан.future— документ относится к более поздней advanced phase.
Translation Status Values
source— английский source-of-truth document.translated— русский перевод существует.not translated— русского перевода пока нет.translation only— русский файл зеркалит английский source.
Current Documents
| Document | Purpose | Tier | Status | Translation Status | When to Update |
|---|---|---|---|---|---|
docs/index.md |
Documentation home and orientation. | Tier 1 | existing | translated | При изменении navigation или project positioning. |
docs/architecture.md |
High-level architecture overview. | Tier 1 | existing | translated | При изменении architecture boundaries или linked docs. |
docs/roadmap.md |
Phases, statuses, current focus. | Tier 1 | existing | translated | При изменении phase status, current focus или sequencing. |
docs/documentation-map.md |
Documentation index, tiers, status, translations. | Tier 1 | existing | translated | При добавлении, rename, retire или translation docs. |
docs/naming-conventions.md |
OpenCart naming и shop3_ prefix rules. |
Tier 1 | existing | translated | При изменении naming rules. |
docs/theme-settings-engine.md |
Theme Settings Engine architecture. | Tier 1 | existing | translated | Перед изменениями settings contract. |
docs/development-workflow.md |
Branch, commit, PR, review, merge workflow. | Tier 1 | existing | not translated | При изменении GitHub workflow. |
docs/pr-checklist.md |
PR validation checklist. | Tier 1 | existing | not translated | При изменении validation requirements. |
docs/environment-strategy.md |
Domain and environment roles. | Tier 1 | existing | not translated | При изменении domain roles. |
docs/ops-workflow.md |
OPS issue workflow. | Tier 1 | existing | not translated | При изменении OPS logging rules. |
docs/architecture-principles.md |
Engineering principles. | Tier 1 | existing | not translated | При изменении principles. |
docs/system-boundaries.md |
Responsibility boundaries. | Tier 1 | existing | not translated | При изменении boundaries. |
docs/product-philosophy.md |
Product/platform direction. | Tier 1 | existing | not translated | При изменении product philosophy. |
docs/community-driven-development.md |
Ideas, donations and roadmap priority. | Tier 1 | existing | not translated | При изменении community workflow. |
docs/community-governance.md |
How decisions are accepted/rejected. | Tier 1 | existing | not translated | При изменении governance process. |
Maintenance Rules
- Project-wide decisions live in the relevant English document.
- Русские переводы не должны вводить новые rules.
- OPS state lives in GitHub issues.
- Product architecture lives in repository docs.
- Empty Russian placeholders are not created.