Навык document
Пишет или обновляет техническую документацию, следуя конвенциям проекта и специфичным для профиля рубрикам после реализации фич или исправления багов.
- Звёзды на GitHub
- 155
- Файлы
- 16
- Последний коммит
- 10 нояб. 2026 г.
- Лицензия
- —
- Разрешённые инструменты
- —
Что делает навык document?
Пишет или обновляет техническую документацию, следуя конвенциям проекта и специфичным для профиля рубрикам после реализации фич или исправления багов.
Сводка сгенерирована из SKILL.md навыка.
О skill document
Основная функция этого SKILL — обновление технической документации после завершения работы над фичей или исправления багов. Он предназначен для разработчиков, которым необходимо обеспечить точное отражение изменений в коде в файлах проекта при соблюдении специфических организационных стандартов. Процесс начинается с инспекции директории фичи и определения активных профилей с помощью специальной процедуры детекции. Как только профили идентифицированы, SKILL загружает соответствующие рубрики из файлов index.md, расположенных в поддиректориях документации конкретных профилей.
Агенту следует загружать этот SKILL сразу после этапа реализации, чтобы поддерживать целостность документации. Он создает обновленные файлы README, руководства по архитектуре, документацию API или Architecture Decision Records (ADRs) в соответствующих директориях проекта. SKILL опирается на общие протоколы, такие как shared-capy-knowledge-protocol.md и shared-profile-detection.md, для формирования процесса написания. В отличие от стандартных инструментов написания текста, он требует явной обработки обязательных тем: либо путем написания контента, либо указанием N/A с объяснением причины, либо ссылкой на унаследованные источники, чтобы избежать скрытых пропусков.
Что агент может делать с ним
- 1Документирование изменений в новых фичахПисать или обновлять техническую документацию для недавно реализованной фичи в соответствии с конвенциями проекта.
- 2Фиксация архитектурных решенийСоздавать Architecture Decision Record, если изменение кода подразумевало выбор между несколькими альтернативами.
- 3Применение рубрик конкретных профилейГарантировать, что документация охватывает все обязательные темы, определенные в файле index.md активного профиля.
- 4Поддержание полноты документацииОтрабатывать каждую обязательную тему, предоставляя контент, причину N/A или ссылку на унаследованный источник.
Написано на основе skill SKILL.md. Каждый сценарий использования проверен по цитате из него.
Как установить навык document
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка document в Плагин
/plugin marketplace add serpro69/claude-toolbox /plugin install kk@claude-toolbox
Установка навыка document в Claude Code
~/.claude/skills/document/SKILL.md
$ npx degit serpro69/claude-toolbox/klaude-plugin/skills/document ~/.claude/skills/documentУстановка навыка document в Claude Code (project)
.claude/skills/document/SKILL.md
$ npx degit serpro69/claude-toolbox/klaude-plugin/skills/document .claude/skills/documentУстановка навыка document в Codex
~/.agents/skills/document/SKILL.md
$ npx degit serpro69/claude-toolbox/klaude-plugin/skills/document ~/.agents/skills/documentУстановка навыка document в Gemini CLI
~/.gemini/skills/document/SKILL.md
$ npx degit serpro69/claude-toolbox/klaude-plugin/skills/document ~/.gemini/skills/documentУстановка навыка document в Claude.ai
npx degit serpro69/claude-toolbox/klaude-plugin/skills/document document && zip -r document.zip document # claude.ai → Customize → Skills → + → Create skill → Upload a skill → document.zip
Автоматические проверки
Запущено 14 нояб. 2026 г.Полный отчёт →Ещё не проверен. Навыку нужно 80 баллов, ни одной серьёзной находки и достаточно данных для проверки. Как работают проверки · Что исправить, чтобы получить больше баллов
- Связанный и доступный исходный репозиторийserpro69/claude-toolbox/klaude-plugin/skills/document is public and reachablegithub.com/serpro69/claude-toolbox/tree/HEAD/klaude-plugin/s ↗Пройдено
- Open source лицензия (OSI)No licenseПроблема
- Коммит или релиз за последний годLast commit 2026-11-10github.com/serpro69/claude-toolbox/commits ↗Пройдено
- В скриптах нет загрузки с запуском и кражи учётных данныхNo scripts in the skill folderПройдено
- В SKILL.md нет скрытых инструкцийNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/serpro69/claude-toolbox/blob/HEAD/klaude-plugin/s ↗Пройдено
- Заранее разрешённые инструменты ограниченыNo pre-approved tools; the agent asks before using onegithub.com/serpro69/claude-toolbox/blob/HEAD/klaude-plugin/s ↗Пройдено
- SKILL.md соответствует формату Agent SkillsValid name and description; says when to use it; 35 linesgithub.com/serpro69/claude-toolbox/blob/HEAD/klaude-plugin/s ↗Пройдено
SKILL.md
Открыть на GitHubDocumentation Process
Conventions
- Read capy knowledge base conventions at shared-capy-knowledge-protocol.md.
- Read profile detection at shared-profile-detection.md. When an active profile contributes a
document/subdirectory (e.g.,${TOOLBOX_PLUGIN_ROOT}/profiles/k8s/document/), itsindex.mdlists a doc rubric — required topics the documentation for that artifact type must cover. See the Workflow below for the load order.
Workflow
Mandatory order — instructions before action. The flow below is strictly sequential. Do not read feature-tree content, write, or edit documentation files until the shared protocols and all resolved profile content are in context. Bounded signal inspection for profile detection is the only content-read exception.
Read the shared protocols in Conventions before the steps below, even when the invocation ultimately needs no edits.
- Minimal-scope listing. List the feature directory (filenames and metadata only — no file-content reads). This is the input profile detection needs, and nothing more; content-level reading happens after profile content is loaded.
- Detect active profiles. Run the
shared-profile-detection.mdprocedure against the filename list from Step 1. - Load profile content. For each active profile that contributes a
document/subdirectory, load${TOOLBOX_PLUGIN_ROOT}/profiles/<name>/document/index.mdand read its always-load + any matching conditional content. The rubric named there specifies topics the documentation must cover for that profile's artifacts. - Read the feature-tree content the documentation will cover. This is the first step that touches subject-matter content; the profile rubric is now loaded and frames what to look for.
- Apply the doc guidelines below. Write or update documentation applying the rubric's required topics where applicable. Explain the purpose and applicable current or planned behavior before reference detail, retaining evidence limits and unresolved decisions.
- Suggest optional clarification. After creating or materially revising documentation, suggest a
/kk:clarify-docsinvocation naming those output paths. If no documents were created or materially revised, skip the suggestion. Clarification is a separate user-selected editing workflow; this skill neither loads its procedure nor runs it automatically. Drafting still owns clear explanations and every applicable profile-rubric topic, including explicit N/A reasons and inherited-source citations. The suggestion does not replace any project-prescribed review.
Guidelines
- Discover the project's documentation structure. List top-level doc directories and doc-related files at the repo root (e.g.,
docs/,README.md,ARCHITECTURE.md,CONTRIBUTING.md). Scan for architecture guides, testing guides, API docs, user guides, and contributing docs — common locations includedocs/contributing/architecture.md,docs/contributing/testing.md, but every project organizes differently. Update whichever docs are relevant to the change — don't limit yourself to a fixed set of paths. - If the code change included prior decision-making out of several alternatives, document an ADR at
/docs/adrfor any non-trivial/non-obvious decisions that should be preserved. - Profile-aware rubric. For each active profile, apply the doc rubric its
document/index.mdspecifies (loaded in Step 3 of the Workflow). Each required topic must be addressed in one of three ways: (a) write the topic if the feature touches it, (b) stateN/A — <reason>in a single line if the feature does not touch the topic, or (c) cite the inherited source explicitly if the feature assumes the topic but inherits it from elsewhere (e.g., NetworkPolicy defined in a platform repo). Silent omission is the failure mode — an explicitN/Acommunicates consideration; an absent heading communicates nothing.
Capy search: Before writing docs, search kk:arch-decisions and kk:project-conventions for decisions that should be reflected in documentation — decisions not obvious from code alone.
Файлы в этом навыке
16Вопросы о навыке document
Как установить навык document в Claude Code?
Выполните npx degit serpro69/claude-toolbox/klaude-plugin/skills/document ~/.claude/skills/document. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык document?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.
Что делать, если требуемая тема документации не применима к данной фиче?
Вы должны явно указать «N/A — <причина>» в одну строку, а не просто удалять заголовок.
Когда следует создавать Architecture Decision Record (ADR)?
Вам следует задокументировать ADR в /docs/adr, если изменение кода включало нетривиальный или неочевидный выбор между несколькими альтернативами.
Каков обязательный порядок действий для этого SKILL?
Рабочий процесс должен строго следовать последовательности: составление списка минимального охвата, определение профиля, загрузка содержимого профиля, чтение содержимого дерева фич, применение руководств и предложение необязательных уточнений.