doc-edit
Skill15 starsChanged 5 months agoMITView on GitHub
Update documentation files including README, comments, and inline docs. Use proactively for documentation updates.
In this repository21 other files it gives its agents.
- AGENTS.mdAGENTS.md
- public/llms-full.txtllms.txt
- public/llms.txtllms.txt
- add-componentSkill
- add-diagram-componentSkill
- add-languageSkill
- add-pageSkill
- ai-diff-reviewerSkill
- dailybotSkill
- deepworkplanSkill
- fix-lintSkill
- git-commit-pushSkill
- pr-review-liteSkill
- quick-fixSkill
- refactor-safeSkill
- responsive-lighthouse-auditSkill
- security-checkSkill
- translate-syncSkill
- type-fixSkill
- update-stylesSkill
- write-testsSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
13 rules. About 0 are common, 13 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈13
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 20
Update documentation files such as README, code comments, JSDoc, and markdown files.
- Distinctive: line 31
Does NOT modify code logic
- Distinctive: line 32
Does NOT add new features
- Distinctive: line 33
Does NOT refactor code
- Distinctive: line 34
Does NOT change function signatures
- Distinctive: line 35
Does NOT update tests
- Distinctive: line 56
Before running this skill, ensure:
- Distinctive: line 65
Read the documentation task
- Distinctive: line 77
Update documentation following existing style
- Distinctive: line 80
All content in English
- Distinctive: line 84
Check spelling and grammar
- Distinctive: line 85
Verify links work (if applicable)
- Distinctive: line 86
Run lint if touching code files with comments only:
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Skill: Doc Edit
Objective
Update documentation files such as README, code comments, JSDoc, and markdown files. This skill handles documentation-only changes with no code logic modifications. Adapted for this Astro repo: follow docs/ and AGENTS.md; all content in English; supports MDX in content collections.
Scope includes:
docs/*.md- Project documentationsrc/**/README.md- Component/folder documentationsrc/content/{methodology,spec,kit}/{en,es}/*.md- Methodology/spec/kit docssrc/content/pages/{en,es}/*.md- Agent-friendly page Markdown endpoints- Code comments in
.astro,.svelte,.tsfiles
Non-Goals
- Does NOT modify code logic
- Does NOT add new features
- Does NOT refactor code
- Does NOT change function signatures
- Does NOT update tests
Tier Classification
Tier: 1 - Light/Cheap
Reasoning: Documentation-only changes are low risk, don't affect runtime behavior, and follow clear patterns. No complex reasoning required.
Inputs
Required Parameters
$TASK: Description of what documentation needs updating$FILES: File(s) to update (optional - will search if not provided)
Optional Parameters
$STYLE: Documentation style guide to follow (default: infer from existing; see docs/DOCUMENTATION_GUIDE.md)
Prerequisites
Before running this skill, ensure:
- Documentation change is clearly defined
- No code logic changes are needed
Steps
Step 1: Understand the Request
- Read the documentation task
- Identify which files need updating (docs/, README, code comments)
- Note the documentation style used (see AGENTS.md, docs/)
Step 2: Review Existing Documentation
- Read current documentation
- Note formatting patterns
- Identify style conventions
Step 3: Make Updates
- Update documentation following existing style
- Keep formatting consistent
- Preserve voice and tone
- All content in English
Step 4: Validate
- Check spelling and grammar
- Verify links work (if applicable)
- Run lint if touching code files with comments only:
pnpm run biome:checkOutput Format
Success Output
## ✅ Documentation Updated
### Summary
{What was documented}
### Files Changed
- `{file1}`: {what changed}
- `{file2}`: {what changed}
### Commit Message
docs: {description}Guardrails
Scope Limits
- Maximum files: 10
- Maximum LOC: 200 (documentation lines)
- Allowed: .md, .txt, comments in code files; docs/
- Forbidden: Modifying code logic
Stop Conditions
Stop immediately if:
- Request involves code logic changes
- Documentation requires technical decisions
- Style guide is unclear and significant
Definition of Done
- Documentation is accurate
- Formatting is consistent
- Spelling/grammar is correct
- No code logic was modified
Escalation Conditions
Escalate if:
- Code changes are also needed
- Technical decisions required
- Major documentation restructuring needed
Related
- quick-fix - For code fixes
- reviewer - For reviewing docs
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

