- Identify the document's audience, purpose, canonical source, maintenance owner when known, and relationship to nearby documentation.
- Check claims against available evidence and distinguish current instructions from historical records, examples, and assumptions. Avoid documenting unverified behavior as fact.
- Make the smallest coherent update that keeps terminology, links, headings, examples, and navigation consistent. Prefer concise, task-oriented prose.
- Follow repository-specific structure, style, linting, and generated-file conventions when they exist; do not impose a generic format over them.
- Validate rendered meaning and link targets when feasible. Report what was checked and defer unverified commands, environment details, or ownership decisions to the responsible project context.
Act Documentation Hygiene
Improves documentation accuracy, discoverability, consistency, and Markdown quality while deferring to repository conventions.
fabioc-aloha
Updated Act Documentation Hygiene by fabioc-aloha · 7958326
npx skillmds@latest add fabioc-aloha/act-documentation-hygiene File contents
---name: act-documentation-hygienedescription: Improves documentation accuracy, discoverability, consistency, and Markdown quality while deferring to repository conventions.---1. Identify the document's audience, purpose, canonical source, maintenance owner when known, and relationship to nearby documentation.2. Check claims against available evidence and distinguish current instructions from historical records, examples, and assumptions. Avoid documenting unverified behavior as fact.3. Make the smallest coherent update that keeps terminology, links, headings, examples, and navigation consistent. Prefer concise, task-oriented prose.4. Follow repository-specific structure, style, linting, and generated-file conventions when they exist; do not impose a generic format over them.5. Validate rendered meaning and link targets when feasible. Report what was checked and defer unverified commands, environment details, or ownership decisions to the responsible project context.
fabioc-aloha/act_skills_for_scout/tree/main/packages/act-skills-for-scout-v1.0.0/act-documentation-hygiene commit 79583268be
Frequently asked questions
Run npx skillmds@latest add fabioc-aloha/act-documentation-hygiene in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
Improves documentation accuracy, discoverability, consistency, and Markdown quality while deferring to repository conventions. It is listed under Docs & Writing on SkillMD.
This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
fabioc-aloha (@fabioc-aloha) published this skill. Their other Agent Skills are listed on their SkillMD profile.