Навык docs
Use after a change or a release, to write and refresh the runbook and the how-to guides of the project, so the runbook and the guides match the code.
- Звёзды на GitHub
- 102
- Файлы
- 1
- Последний коммит
- 6 нояб. 2026 г.
- Лицензия
- MIT
- Разрешённые инструменты
- —
Что делает навык docs?
Use after a change or a release, to write and refresh the runbook and the how-to guides of the project, so the runbook and the guides match the code.
Как установить навык docs
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка docs в Плагин
/plugin marketplace add DataWithBaraa/claude-code-data-engineering-skills /plugin install data-engineering@data-with-baraa
Установка навыка docs в Claude Code
~/.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docsУстановка навыка docs в Claude Code (project)
.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs .claude/skills/docsУстановка навыка docs в Codex
~/.agents/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.agents/skills/docsУстановка навыка docs в Gemini CLI
~/.gemini/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.gemini/skills/docsУстановка навыка docs в Claude.ai
npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs docs && zip -r docs.zip docs # claude.ai → Customize → Skills → + → Create skill → Upload a skill → docs.zip
SKILL.md
Открыть на GitHubDocs
The job: the runbook and the how-to guides, matching the code every time. It writes the docs, never the code. The standards and the source pages are checked by the knowledge-refresh skill, and the incident log gets its entries from the incident skill.
Input: none, or the change to document.
Steps
- List what changed since the docs were last written: the diff, the new files, the renamed things.
- The runbook: every command, in order, as it runs today. Check that each command exists and that its flags parse, with --help or a dry run. Never run a command that writes data or starts a job.
- The how-to guides: one per repeated task of the project, the steps as a new colleague would follow them.
- Check every guide against the code: every path exists, every name is the name in the code.
- Link the facts instead of copying them. A source, a business term or a rule links to its page in the knowledge, and a repeated passage becomes a link.
- Report what was out of date and what is now written.
Output
The runbook and the how-to guides as Markdown files in the docs folder, every command and every path checked against the code.
Reads
- the code, the scripts, the run records, the existing docs, the knowledge
Writes
- the runbook and the how-to guides
Never
- Never changes the code to match the docs.
- Never invents a fact: where the code says nothing, write "unknown".
Файлы в этом навыке
1Вопросы о навыке docs
Как установить навык docs в Claude Code?
Выполните npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docs. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык docs?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.