docs skill
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 stars
- 102
- Files
- 1
- Last commit
- Nov 6, 2026
- License
- MIT
- Allowed tools
- —
What does the docs skill do?
docs uses 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.
How to install the docs skill
Each command copies the skill folder into the client's skills directory. Restart the client or start a new session to load it.Install the docs skill in Plugin
/plugin marketplace add DataWithBaraa/claude-code-data-engineering-skills /plugin install data-engineering@data-with-baraa
Install the docs skill in Claude Code
~/.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docsInstall the docs skill in Claude Code (project)
.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs .claude/skills/docsInstall the docs skill in Codex
~/.agents/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.agents/skills/docsInstall the docs skill in Gemini CLI
~/.gemini/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.gemini/skills/docsInstall the docs skill in 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
View on 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".
Files in this skill
1docs skill questions
How do I install the docs skill in Claude Code?
Run npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docs. Claude Code loads skills from ~/.claude/skills (all projects) or .claude/skills (one project) and uses a skill when its description matches the task.
Which clients can use the docs skill?
Any client that reads the Agent Skills format: Claude Code, Codex, Gemini CLI and claude.ai (upload as a ZIP). Scripts in the skill run only where the client allows code execution.