Каждая значимая техническая статья по возможности содержит #
- Статус:
Актуально(Current) /Устарело(Deprecated) /Историческое(Historical) - Последняя проверка: дата, когда содержание последний раз сверялось с кодом/production
- Исходный файл: путь в Git, если статья отражает файл
- Связанный код: модули, классы, эндпоинты
- Связанный Git-коммит / релиз
- Назначение
- Как это работает
- Важные бизнес-правила
- Известные ограничения
Блок метаданных #
Начинайте технические статьи с блока вида:
Статус: Актуально
Последняя проверка: ГГГГ-ММ-ДД
Источник: Git
Исходный файл: docs/EXAMPLE.md
Git-коммит: <sha>Какой документ за что отвечает #
| Документ | Отвечает на вопрос |
|---|---|
| Журнал изменений production | Что изменилось на production и в каком развёрнутом коммите. |
| Статья Wiki | Как система работает сейчас. |
| Markdown в Git | Технический источник истины рядом с кодом. |
| Справочник для агентов | Краткая и точная информация, которую AI/агент должен прочитать перед изменением подсистемы. |
Статусы #
- Актуально — описывает систему так, как она работает на production.
- Устарело — больше не точно; сохраняется со ссылкой на замену.
- Историческое — намеренно сохранённая запись (исследования, прошлые решения).
Никогда не перезаписывайте статью непроверенной информацией. Если есть сомнения — пометьте её как «Устарело» или оставьте старую дату «Последняя проверка».
Язык #
Основной язык Wiki — русский; у каждой статьи по возможности есть английская версия, связанная с ней как перевод. Технические идентификаторы и названия элементов интерфейса приложения не переводятся.