mirror of
https://github.com/Ku6epXBOCTuK/easy-png-tools.git
synced 2026-11-13 17:08:20 +00:00
60 lines
3.7 KiB
Markdown
60 lines
3.7 KiB
Markdown
# Архив документов
|
|
|
|
> Статус: **active**. Здесь хранятся завершённые, отменённые и явно устаревшие
|
|
> документы как временная историческая справка. Этот README — единственный
|
|
> документ архива со статусом `active`: он описывает процедуру, а не архивный
|
|
> материал, поэтому не подлежит 30-дневному удалению.
|
|
|
|
## Назначение
|
|
|
|
Архив помогает быстро посмотреть, какое решение принималось раньше и почему. Он
|
|
не является источником текущих требований, критериев приёмки или команды. Для
|
|
актуальных правил используются `AGENTS.md`, `docs/README.md` и активные планы.
|
|
|
|
Если решение снова понадобится, его можно восстановить из git history или
|
|
создать новый активный документ: **архивные файлы удаляются, а не хранятся
|
|
вечно.** Удалённые планы восстановимы через
|
|
`git log --diff-filter=D -- name-only -- docs/archive/` и
|
|
`git show <commit>^:<path>`.
|
|
|
|
## Обязательные метаданные
|
|
|
|
При переносе документа в архив добавить в начало:
|
|
|
|
```text
|
|
> Статус: archived
|
|
> Архивирован: YYYY-MM-DD
|
|
> Удалить после: YYYY-MM-DD
|
|
> Причина: краткое объяснение, почему документ больше не активен
|
|
> Использование: только историческая справка
|
|
```
|
|
|
|
Дата `Удалить после` — дата архивирования плюс 30 дней.
|
|
|
|
## Порядок архивирования
|
|
|
|
1. Убедиться, что документ действительно завершён, отменён или заменён более
|
|
актуальным источником.
|
|
2. Убрать из него ссылки на несуществующие пути и артефакты прошлых волн.
|
|
3. Добавить обязательные метаданные.
|
|
4. Переместить файл в `docs/archive/`.
|
|
5. Найти оставшиеся входящие ссылки:
|
|
`git grep -n "<filename>" -- 'docs/*.md' AGENTS.md README.md web/eslint-plugins/README.md`.
|
|
Шаг 4 ломает их, и агент без этого шага напишет в новом документе ссылку на
|
|
удалённый файл. Ожидаемо неразрешимыми остаются ссылки на
|
|
`docs/plan-domain.local.md` — он вне git, это не ошибка (`docs/README.md`,
|
|
раздел «Правила»).
|
|
6. Не менять архивный документ под новые требования.
|
|
|
|
## Удаление
|
|
|
|
Через 30 дней после архивирования:
|
|
|
|
- проверить, что документ не нужен для текущей работы;
|
|
- найти и удалить оставшиеся ссылки на него из активных документов;
|
|
- удалить файл из `docs/archive/`.
|
|
|
|
До истечения срока архивный файл не превращается обратно в live-документ: если
|
|
он снова актуален, создаётся новый документ или возвращается версия из git
|
|
истории с новым статусом и датами.
|