doc-examples
Use when writing, repairing, or auditing realistic worked examples, tutorials, doctests, or examples embedded in API documentation.
- License 许可
- GPL-3.0
- 最近更新
- 2026-11-13
- Stars
- ★ 0
- Forks
- 0
01 前言 Front Matter
- name
- doc-examples
- description
- Use when writing, repairing, or auditing realistic worked examples, tutorials, doctests, or examples embedded in API documentation.
03 SKILL.md 正文
Read the documentation and testing contracts. Start from a user task, not an isolated method call. Make the smallest example useful, copyable, and honest: state prerequisites, inputs, expected observation, failure behavior where relevant, and the next step. Put a representative example near the beginning of the document and link advanced variants.
Use the local executable-example convention. If the example is code, route its verification to the appropriate test leaf after documentation ownership is settled. Prefer several small examples over one opaque script. Avoid output that depends on timestamps, paths, randomness, or private data unless it is normalized and explained.
Return the example inventory, changed paths, command/result evidence, and any example that remains illustrative rather than executable.
04 同仓库更多 Skills
writing-skills
Use when creating new skills, editing existing skills, or verifying skills work before deployment
writing-plans
Use when you have a spec or requirements for a multi-step task, before touching code
verification-before-completion
Use when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always
using-superpowers
Use when starting any conversation - establishes how to find and use skills, requiring skill invocation before ANY response including clarifying questions
using-git-worktrees
Use when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback
test-driven-development
Use when implementing any feature or bugfix, before writing implementation code