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スター
- 102
- ファイル
- 1
- 最終コミット
- 2026年11月6日
- ライセンス
- MIT
- 許可されたツール
- —
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.
docs skillのインストール方法
各コマンドはskillフォルダをクライアントのskillsディレクトリにコピーします。読み込むには、クライアントを再起動するか新しいセッションを開始してください。プラグインにdocs skillをインストールする
/plugin marketplace add DataWithBaraa/claude-code-data-engineering-skills /plugin install data-engineering@data-with-baraa
Claude Codeにdocs skillをインストールする
~/.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docsClaude Code (project)にdocs skillをインストールする
.claude/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs .claude/skills/docsCodexにdocs skillをインストールする
~/.agents/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.agents/skills/docsGemini CLIにdocs skillをインストールする
~/.gemini/skills/docs/SKILL.md
$ npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.gemini/skills/docsClaude.aiにdocs skillをインストールする
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
GitHubで表示Docs
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".
このスキルのファイル
1docs skillに関する質問
Claude Codeにdocs skillをインストールするには
npx degit DataWithBaraa/claude-code-data-engineering-skills/skills/docs ~/.claude/skills/docsを実行してください。Claude Codeは~/.claude/skills(すべてのプロジェクト)または.claude/skills(単一プロジェクト)からskillsを読み込み、説明がタスクに一致する場合にskillを使用します。
docs skillはどのクライアントで使用できますか
Agent Skills形式を読み込むすべてのクライアントで使用できます: Claude Code、Codex、Gemini CLI、claude.ai(ZIPとしてアップロード)。skill内のスクリプトは、クライアントがコード実行を許可した場合にのみ実行されます。