Documentation skill
Skill Podcast72/agent-skill-starter-kit/examples/documentation-skill
A practical starter kit for turning repeated AI agent workflows into reusable local skills with scripts, templates, checks, and optional hooks.
npx -y skills add Podcast72/agent-skill-starter-kit --skill documentation-skillAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Use this skill for local documentation tasks that need clear scope, consistent writing rules, and a stable final report.
SKILL.md
1.5 KB, as published. Nobody here has run it
Documentation Skill
What this skill does
Use this skill for documentation-focused tasks such as:
- writing or rewriting
README.md; - updating guides or internal notes stored in the repository;
- improving structure, clarity, headings, examples, or usage steps;
- keeping a final report consistent across repeated documentation tasks.
Activation
Activate this skill when the task is primarily about documentation, explanations, or Markdown structure.
Scope
- Local repository documentation only.
- Small to medium documentation edits.
- No network access by default.
- No global configuration changes.
- No destructive commands.
Rules
- Read the existing document before rewriting it.
- Preserve the technical meaning unless the task explicitly asks for a change.
- Prefer short, clear sections over long narrative text.
- Keep examples small and practical.
- Report what changed and what was not checked.
Stop rules
- Stop if the task requires changes outside the approved documentation scope.
- Stop if the request becomes ambiguous about audience, tone, or target files.
- Stop before adding claims that cannot be supported by the repository content.
Optional template
Use templates/final-report.md when you want a consistent completion summary.
Final report format
MODE:
TASK:
FILES MODIFIED:
WRITING GOALS:
VALIDATION:
LIMITS:
STATUS: