mirror of
https://github.com/Ku6epXBOCTuK/easy-png-tools.git
synced 2026-11-13 17:08:20 +00:00
docs: update a lot of plans, readmes, descriptions
This commit is contained in:
+12
-11
@@ -10,7 +10,10 @@
|
||||
актуальных правил используются `AGENTS.md`, `docs/README.md` и активные планы.
|
||||
|
||||
Если решение снова понадобится, его можно восстановить из git history или
|
||||
создать новый активный документ.
|
||||
создать новый активный документ: **архивные файлы удаляются, а не хранятся
|
||||
вечно.** Удалённые планы восстановимы через
|
||||
`git log --diff-filter=D -- name-only -- docs/archive/` и
|
||||
`git show <commit>^:<path>`.
|
||||
|
||||
## Обязательные метаданные
|
||||
|
||||
@@ -24,19 +27,18 @@
|
||||
> Использование: только историческая справка
|
||||
```
|
||||
|
||||
Дата `Удалить после` — дата архивирования плюс 30 дней. Старые файлы, созданные
|
||||
до введения политики, могут не иметь этих дат; они также считаются архивными и
|
||||
не являются активными требованиями. При следующем касании их можно удалить или
|
||||
привести к шаблону.
|
||||
Дата `Удалить после` — дата архивирования плюс 30 дней.
|
||||
|
||||
## Порядок архивирования
|
||||
|
||||
1. Убедиться, что документ действительно завершён, отменён или заменён более
|
||||
актуальным источником.
|
||||
2. Добавить обязательные метаданные.
|
||||
3. Переместить файл в `docs/archive/`.
|
||||
4. Проверить ссылки из backlog, планов, checklist и `docs/README.md`.
|
||||
5. Не менять архивный документ под новые требования.
|
||||
2. Убрать из него ссылки на несуществующие пути и артефакты прошлых волн.
|
||||
3. Добавить обязательные метаданные.
|
||||
4. Переместить файл в `docs/archive/`.
|
||||
5. Проверить ссылки из backlog, планов, checklist и `docs/README.md`: удалённые
|
||||
файлы должны потерять и входящие ссылки.
|
||||
6. Не менять архивный документ под новые требования.
|
||||
|
||||
## Удаление
|
||||
|
||||
@@ -44,8 +46,7 @@
|
||||
|
||||
- проверить, что документ не нужен для текущей работы;
|
||||
- найти и удалить оставшиеся ссылки на него из активных документов;
|
||||
- удалить файл из `docs/archive/`;
|
||||
- при необходимости отметить удаление в истории изменений.
|
||||
- удалить файл из `docs/archive/`.
|
||||
|
||||
До истечения срока архивный файл не превращается обратно в live-документ: если
|
||||
он снова актуален, создаётся новый документ или возвращается версия из git
|
||||
|
||||
Reference in New Issue
Block a user