doc-edit

更新包括 README、注释与内联文档在内的文档文件。请主动用于文档更新。

SKILL.md

--- frontmatter

name: doc-edit
description: Update documentation files including README, comments, and inline docs. Use proactively for documentation updates.
# === Universal (Claude Code + Cursor + Codex) ===
disable-model-invocation: false
# === Claude Code specific ===
allowed-tools: Read, Write, Edit, Glob, Grep
model: haiku
# === Documentation (ignored by tools, useful for humans) ===
tier: 1
intent: docs
max-files: 10
max-loc: 200

Skill: Doc Edit

Objective

Update documentation files such as README, code comments, JSDoc/docstrings, and markdown files. This skill handles documentation-only changes with no code logic modifications.

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)

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
•Note the documentation style used

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

Step 4: Validate

•Check spelling and grammar
•Verify links work (if applicable)
•Ensure formatting is correct

bash

# If markdown linting available
npm run lint:md

Output Format

Success Output

code

## ✅ Documentation Updated

### Summary
{What was documented}

### Files Changed
- `{file1}`: {what changed}
- `{file2}`: {what changed}

### Commit Message

docs: {description}

code

Guardrails

Scope Limits

•Maximum files: 10
•Maximum LOC: 200
•Allowed: .md, .txt, comments in code files
•Forbidden: Modifying code logic

Safety Checks

• No code logic changes
• Follows existing documentation style
• Links are valid
• Formatting is consistent

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

Examples

Example 1: Update README

Input:

code

$TASK: Add installation instructions for Docker
$FILES: README.md

Output:

code

## ✅ Documentation Updated

### Summary
Added Docker installation instructions to README

### Files Changed
- `README.md`: Added Docker setup section with commands

Example 2: Add JSDoc Comments

Input:

code

$TASK: Add JSDoc to the utils functions
$FILES: src/utils/helpers.ts

Output:

code

## ✅ Documentation Updated

### Summary
Added JSDoc documentation to 5 utility functions

### Files Changed
- `src/utils/helpers.ts`: Added @param and @returns for all exported functions

Related Skills/Agents

•quick-fix - For code fixes
•reviewer - For reviewing docs

Changelog

Version	Date	Changes
1.0.0	2024-01	Initial version