agentleFS
radif-ruradif-ru/ai-multi-agent-system/.agents/skills/documentation-discipline/SKILL.md

documentation-discipline

Skill6 starsChanged 4 months agoMITView on GitHub

Дисциплина документации: только относительные пути, синхронизация ссылок через grep, doc-before-code, закрытые спринты не трогаем, источник истины — код.

  • Reads credentials

The file

Files
SKILL.md

Skill: documentation-discipline

Правила работы с документацией проекта. Источник истины — _docs/instructions.md §9 и _board/process.md §8.

Когда использовать

  • Меняешь поведение системы — нужно обновить профильный документ в _docs/ до или вместе с кодовым коммитом.
  • Правишь _docs/, _board/, README.md, .env.example, app/prompts/, app/skills/, .agents/.
  • Переименовываешь или переносишь файл либо раздел — нужно поправить ссылки.

Не использовать для правок кода без изменения поведения (рефакторинг, не добавляющий новых фактов в документацию).

Алгоритм

  1. Только относительные пути. Запрещены абсолютные пути ФС (/home/..., /Users/..., C:\...). Все ссылки — от корня проекта (_docs/..., app/..., ./architecture.md).
  2. Язык — по §1 (_docs/instructions.md): по умолчанию русский; технические идентификаторы (имена модулей, функций, env, путей) — латиницей.
  3. Doc-before-code. Поведение сначала описывается в профильном документе (requirements.md / commands.md / agent-loop.md / tools.md / memory.md / skills.md), затем меняется код. Кодовый коммит, меняющий поведение, без обновления документации не принимается (§9; _board/process.md §8).
  4. Синхронизация ссылок. При переименовании/удалении файла или смене номера/названия раздела — grep -rn по репозиторию и починить все живые ссылки.
  5. Закрытые спринты — архив. Файлы _board/sprints/<NN>-*.md со статусом Closed не трогаем (_board/process.md §2 п.5).
  6. Источник истины — код. При расхождении документ приводится к коду отдельным docs(...)-коммитом.

Чего избегать

  • Абсолютных путей ФС в любой документации.
  • «Висячих» ссылок после переименования — всегда проверяй grep -rn.
  • Правок закрытых спринтов.
  • Кодового коммита, меняющего поведение, без обновления документации.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.