agentleFS
ManshoooManshooo/astral-genesis/.claude/skills/docs-sync/SKILL.md

docs-sync

Skill3 starsChanged 52 days agoMITView on GitHub

Держит документацию Astral Genesis правдой о коде и разводит знание по местам — описание механики в Obsidian-вики docs/astral-genesis/, в коде только короткие пометки о ловушках решения, в CLAUDE.md карта-указатель. Запускать после фичи/рефакторинга, менявшего поведение или связи систем, по просьбе «актуализировать документацию», «почистить/проверить комментарии», перед закрытием карточки в docs/astral-genesis/Задачи/, а также когда нужно поднять подробности по конкретной системе или механике.

47 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use tdd, code-review and 2 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    tdd

    Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

    Also in 4 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 5 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 4 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

Files
SKILL.md

Документация: где живёт знание и как держать его правдой

Три места, у каждого своя работа, и ни одно не пересказывает другое:

МестоЧто в нёмЧего в нём нет
Вики docs/astral-genesis/как устроена механика, инварианты, отвергнутые варианты, история решений— единственный источник правды
Кодимена, которые сами говорят, что делают; пометка у строки, где решение неочевидноописание механики, история, пересказ кода
CLAUDE.mdсводка инварианта «что нельзя» + ссылка в викиобъяснение «как работает»

Одно и то же в двух местах — не подстраховка, а гарантированный рассинхрон.

Комментарии: что остаётся в коде

Код документирует себя сам — именами функций, полей, констант. Комментарий нужен только там, где читатель кода споткнётся без него:

  • Ловушка движка или библиотеки: «Jolt на своём потоке — space-state только из _physics_process», «preload кастомного ресурса падает в экспорте (godotengine/godot#100100)».
  • Неочевидное ограничение решения: «порядок обязателен — по нему идут броски общего rng», «free(), а не queue_free(): старый регион не должен дожить до нового слоя».
  • Обходной путь — со ссылкой на причину (issue, раздел вики).
  • Шапка скрипта — одна-две строки «зачем существует» + ссылка на раздел вики (## [[Цикл забега]] §3 или путь). Не конспект раздела.
  • ##-описание у @export — подсказка инспектора: одна строка о смысле и единицах, не теория.

Удаляется:

  • Пересказ кода («проходим по дверям и ставим замок») — это видно из кода.
  • История («раньше было X», «до 08.10 …», «первая версия вешала …») — место ей в коммите и в вики. Оставить можно одну строку, если без неё следующий правщик вернёт старую ошибку: «не C_PlayerInput — с ним execute_one() находил врага вместо игрока».
  • Описание механики целиком — если оно уже в вики, комментарий заменяется ссылкой; если в вики его нет — сначала перенести в вики, потом удалить. Знание не теряется ни при какой чистке.
  • Абзацы там, где хватает строки. Длинный блок — сигнал, что текст хочет жить в вики.

Длина как ориентир, не закон: пометка у строки — 1–3 строки, шапка — до 3 строк плюс ссылка.

Навигация: где что описано

Полная карта — references/doc-map.md. Коротко:

Нужно разобраться в…Читать
модели ECS, «Правиле v9», ECS-паттернахhow-to/GECS и правила движка.md
генерации мира, слоях, дверях, переходах, сейвеhow-to/Цикл забега.md
интерактивных объектах, луче, подсказкахhow-to/Взаимодействие.md
камере от третьего лица, двух лучах прицела, повороте телаhow-to/Камера от третьего лица.md
захвате тела, характеристиках, стабильности и распадеhow-to/Захват тела.md
граблях инструментов редактора, шаблонах сущностейhow-to/Редакторские инструменты.md
звукеhow-to/Звук.md
слоях физики, теме UI, префиксах, ребайнде, настройках проектаСправка/Конвенции проекта.md
CI, версиях, релизахhow-to/Релизы и сборка.md
что вообще уже реализованоСостояние проекта.md

Читать до правки подсистемы. Нет нужного описания — это пробел вики: завести раздел там, где он должен быть по карте, а не восстанавливать логику из кода молча.

Сверка после изменения кода

  1. Объём. git diff / git log от последней ревизии либо список файлов от пользователя.
  2. Вики. По карте найти документ затронутой области и свести с новым поведением: профильный how-to, Состояние проекта.md, карточка в Задачи/. Не описывать несуществующее: откатанная или недоделанная фича в вики называется так, как есть.
  3. Комментарии затронутых .gd — по правилу выше. Комментарий, ссылающийся на переименованное, поправить.
  4. CLAUDE.md — только если стала неверной сама сводка или конвенция, или появился документ, которого нет в таблице «Документация — карта».
  5. Карточки. Задача закрыта → карточка из Задачи/vX.Y.Z.md в Задачи/Завершено/; незапланированная работа → новая карточка.
  6. Ссылки:

    python .claude/skills/docs-sync/scripts/check_doc_references.py

    Идентификаторы C_*/S_*/E_*/O_*/RS_*/A_* и пути, которых нет в коде (роадмап пропускается, --include-roadmap — с ним). Не автофикс: список проверяется глазами. [[wikilinks]] Obsidian на битой ссылке не падает — после переименования искать [[старое имя руками.

    Не наши имена в обратных кавычках (примеры из внешних репозиториев, гипотетические C_Idle) помечаются в конце самой строки комментарием <!-- docs-sync: skip-line --> — скрипт пропускает только эту строку, остальные проверяются. Для длинного куска без своих имён есть блочная пара <!-- docs-sync: skip --> … <!-- /docs-sync: skip --> на отдельных строках. Имя удалённого файла пишется без расширения, чтобы не считаться путём. Маркеры — для примеров, не для заглушения настоящего устаревания.

Чистка комментариев (по запросу или файлу, который правишь)

python .claude/skills/docs-sync/scripts/comment_audit.py [пути] [--block 3] [--top 40]

Показывает длинные блоки и файлы, где комментариев больше четверти, — очередь на чтение, не вердикт. Порядок по каждому файлу:

  1. Найти раздел вики, который описывает этот скрипт (карта выше; в шапке скрипта часто уже есть ссылка).
  2. Каждый блок длиннее пары строк разложить: пересказ кода — удалить; история — удалить или одной строкой-предостережением; описание механики — проверить, есть ли оно в вики: есть → ссылка, нет → дописать в вики, потом удалить; ловушка — сжать до строки у той строки кода, которой она касается.
  3. Код не трогать: чистка комментариев не меняет поведения. Сторож — python .claude/skills/docs-sync/scripts/code_unchanged.py (код без комментариев против HEAD, выход 1 с диффом, если ушло что-то кроме комментария). Затем затронутые проверки или pwsh dev/run_checks.ps1.
  4. Коммит — отдельно от функциональных изменений, область Комментарии: или Документация:.

Границы

  • Не переписывать стиль и структуру документа без необходимости — только факты.
  • Не документировать будущее в Состояние проекта.md — для этого Задачи/.
  • Не трогать История.md (лор), если не попросили явно.
  • Не раздувать CLAUDE.md: любое добавление туда — сводка и ссылка.
  • addons/gecs/ — апстрим, его комментарии не наши.

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.