agentleFS
Sign inStart free
goldenprofilegoldenprofile/llm-skills/skills/docs-generator/SKILL.md

docs-generator

Skill3 starsChanged 3 months agoMITView on GitHub

README, ADR, docstrings (Google-стиль) и синхронизация CLAUDE.md/AGENTS.md: написать недостающее и найти протухшее. Документирует «почему», а не пересказывает код. Используй когда пользователь говорит «как улучшить документацию монолита», «посмотри статус документации проекта», просит написать или обновить README, оформить ADR, добавить docstrings, синхронизировать CLAUDE.md. Спека, план или записка для CEO — spec-writer; DoD и tooling-обвязка — harness-engineering; понять чужой код — codebase-recon.

15 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use attack-chain, binary-diff and 10 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.
  • DorianGalloSkill

    attack-chain

    Also in 5 projects that use this

  • DorianGalloSkill

    binary-diff

    跨版本符号迁移与二进制差分。当你有旧版本的符号/逆向结果，需要快速迁移到新版本时使用。 适用场景：内核缺 PDB 用旧版符号推导、程序更新后批量迁移函数名、应用更新后快速定位新偏移。 核心方法：用 LLM 做结构化差异比对，程序化输入输出，成本极低（200 函数 ~1 元）。 触发关键词：符号迁移、bindiff、跨版本、PDB 缺失、函数偏移迁移、symbol migration、binary diff、版本对比。

    Also in 5 projects that use this

  • Roshu18Skill

    pentest-tools

    Tool selection policy for BearStrike based on target type, scan risk, and signal strength.

    Also in 6 projects that use this

  • zhaoxuya520Skill

    ghidra-reverse

    Use for free/open reverse engineering with Ghidra (headless or GUI), including decompile, cross-refs, and optional Ghidra MCP workflows when IDA is unavailable.

    Also in 3 projects that use this

  • +8 more from DorianGallo

The file

Create a free account to mount
Files
SKILL.md

Docs Generator — документация, которую читают

Генератор и аудитор документации для Python-проектов (Django / FastAPI / aiogram). Ключевая идея: документация — это страховка «будущего тебя» и топливо для агентов, а не бюрократия. Минимум воды, документируем «почему», помечаем устаревшее. Чем меньше команда, тем важнее первое: через полгода единственный носитель контекста — текст в репозитории.

Когда применять

Новый проект без README; пришёл к старому проекту и не помнишь, как он устроен; принял важное архитектурное решение (нужен ADR); публичный/переиспользуемый код без docstrings; CLAUDE.md и AGENTS.md разъехались. Работает в двух режимах — генерация (создать недостающее) и аудит (найти отсутствующее/устаревшее). Незнакомый проект сперва разбери через codebase-recon.

Принципы

  • Документируй «почему», а не «что». Код уже говорит, что он делает. Док объясняет почему так, какие были альтернативы и ограничения — это не вытащить из кода.
  • Минимум воды. Никакой маркетинговой прозы. Каждая строка либо экономит время будущего тебя, либо нужна агенту. Не дублируй очевидное (тип уже в hint — не повторяй его словами).
  • Устаревший док хуже отсутствующего. Он врёт. Помечай (> [!WARNING] устарело: …) или удаляй.
  • Близко к коду. Docstrings — в коде; README — в корне; ADR — в docs/adr/. Не плоди вики.
  • Для агентов. CLAUDE.md/AGENTS.md — кратко и проверяемо; README даёт агенту быстрый старт.

Процесс

  1. Разведка. Что уже есть (README, docs/, docs/adr/, CLAUDE.md, AGENTS.md, docstrings), класс проекта (Django-веб / FastAPI-API / aiogram-бот / automation-скрипт), точки входа.
  2. Аудит. Прогони по чеклисту (ниже): что отсутствует, что устарело (док противоречит коду), что лишнее. Классифицируй по приоритету.
  3. Генерация. Создай/обнови по шаблонам из справочников. Спрашивай только то, чего нет в коде (мотивацию решений для ADR/README); техническое (env, команды запуска) вытаскивай из репозитория.
  4. Вывод. Отчёт по references/output-format.md; правки — по согласованию.

Уровни приоритета (для аудита)

  • CRITICAL — документация врёт: README/CLAUDE.md противоречит коду (неверная команда запуска, несуществующая env-переменная, удалённый модуль) → агент или будущий ты сломает прод.
  • HIGH — нет того, без чего проект не запустить: README без quick start / списка env, CLAUDE.md и AGENTS.md рассинхронизированы, нет ADR для уже принятого нетривиального решения.
  • MEDIUM — публичный API/сервис без docstrings, нет деплой-заметки (systemd/nginx), ADR без раздела «последствия», README без ссылки на архитектуру.
  • LOW — стиль, формулировки, docstring дублирует type hint, мелкие неточности.

Быстрый чеклист

  • README: есть назначение, quick start, полный список env, команда запуска, деплой-заметка?
  • Все команды/env в README и CLAUDE.md реально существуют в коде (не устарели)?
  • CLAUDE.md и AGENTS.md синхронизированы (или AGENTS.md — символьная ссылка/копия)?
  • Принятые нетривиальные решения (выбор БД, async vs sync, отказ от Celery) зафиксированы в ADR?
  • Публичные функции/классы/сервисы имеют docstring, объясняющий «почему», а не тип аргументов?
  • Нет устаревших доков, противоречащих текущему коду (помечены устарело или удалены)?

Связь с библиотекой навыков

  • harness-engineering — canonical docs (ARCHITECTURE.md, WORKFLOW.md), глубокая настройка CLAUDE.md/AGENTS.md (DoD, tooling). docs-generator пишет «человеческие» доки; harness — обвязку для агентов. См. references/agent-docs.md.
  • codebase-recon — запусти ПЕРЕД документированием незнакомого проекта (восстановить архитектуру, точки входа, бизнес-цель), иначе будешь документировать вслепую.
  • python-project-audit — аудит качества кода; docs-generator — аудит и генерация доков к нему.

Справочники

  • references/readme.md — структура README (назначение, quick start, env, запуск, деплой-заметка systemd/nginx), что включать и чего не писать.
  • references/adr.md — лёгкий ADR (MADR): когда писать, нумерация, docs/adr/, шаблон (контекст/решение/последствия), статусы и superseded.
  • references/docstrings.md — Google-style docstrings, что документировать (модуль/класс/функция), связь с type hints, что НЕ писать, примеры (Django/FastAPI/async).
  • references/agent-docs.md — CLAUDE.md/AGENTS.md: что писать (кратко, проверяемо), синхронизация двух файлов, граница с harness-engineering.
  • references/output-format.md — формат отчёта аудита/генерации.

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.

Check your setup, free