docs-simplify
SKILL.md
Documentation Simplification (Meaning-Preserving)
Transform technical/product docs into shorter, clearer text without altering meaning. Preserve terminology, APIs, paths, config keys, and (unless allowed) structure.
Usage Scenarios
Use this Skill when you need to:
- Shorten documentation while preserving meaning
- Keep technical identifiers unchanged (APIs, paths, config keys)
- Improve clarity and consistency across multiple docs
Do NOT use this Skill when:
- You need structural rewrites or marketing copy
- You need translation/localization
- You must add new content or change technical facts
Core Principles
- Meaning first — never change constraints or behavior.
- Identifiers are sacred — APIs/paths/config keys remain unchanged.
- Structure is stable — keep headings and code blocks unless explicitly allowed.
- Brevity with precision — shorter, but still exact.
Workflow
- Confirm scope: target files, audience, and whether headings can change.
- Scan structure: map headings, lists, tables, and code blocks; flag verbose sections.
- Simplify:
- Sentence level: remove redundancy, merge repeats, use active verbs.
- List level: dedupe items, compress descriptions, keep all information.
- Table level: shorten “description/usage” cells while retaining key terms.
- Guardrails:
- Do not change meaning or technical identifiers.
- Keep code blocks and examples unless clearly redundant.
- Keep heading hierarchy unless permission to restructure.
- Consistency pass: terminology, punctuation, and tone.
- Summarize changes: list edited files and high‑level edits.
- Handle ambiguity: if a change could alter meaning, ask a minimal clarification.
Quality Gates
- No technical identifiers changed.
- No meaning/constraints altered.
- Code blocks and paths preserved.
- Lists/tables remain complete.
References
| Topic | Description | Reference |
|---|---|---|
| Concise Editing Guide | Rules and examples for meaning‑preserving edits | reference |
Weekly Installs
2
Repository
huguangju/skillsFirst Seen
Feb 4, 2026
Security Audits
Installed on
trae2
claude-code2
codex2
opencode2
mcpjam1
iflow-cli1