agentleFS
DailybotHQDailybotHQ/deepworkplan-website/.agents/skills/doc-edit/SKILL.md

doc-edit

Skill15 starsChanged 5 months agoMITView on GitHub

Update documentation files including README, comments, and inline docs. Use proactively for documentation updates.

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
  1. Distinctive:

    Update documentation files such as README, code comments, JSDoc, and markdown files.

    line 20
  2. Distinctive:

    Does NOT modify code logic

    line 31
  3. Distinctive:

    Does NOT add new features

    line 32
  4. Distinctive:

    Does NOT refactor code

    line 33
  5. Distinctive:

    Does NOT change function signatures

    line 34
  6. Distinctive:

    Does NOT update tests

    line 35
  7. Distinctive:

    Before running this skill, ensure:

    line 56
  8. Distinctive:

    Read the documentation task

    line 65
  9. Distinctive:

    Update documentation following existing style

    line 77
  10. Distinctive:

    All content in English

    line 80
  11. Distinctive:

    Check spelling and grammar

    line 84
  12. Distinctive:

    Verify links work (if applicable)

    line 85
  13. Distinctive:

    Run lint if touching code files with comments only:

    line 86

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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 documentation
  • src/**/README.md - Component/folder documentation
  • src/content/{methodology,spec,kit}/{en,es}/*.md - Methodology/spec/kit docs
  • src/content/pages/{en,es}/*.md - Agent-friendly page Markdown endpoints
  • Code comments in .astro, .svelte, .ts files

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:check

Output 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

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.