
doc-editing
by iplaylf2
Personal coding profile kit for reusable defaults and setup
SKILL.md
name: doc-editing description: Use when the user asks to edit, polish, or rewrite documentation or long-form prose to improve clarity and structural quality, aiming for publishable text without tone drift or unnecessary structural churn.
Doc Editing
Edit documentation and long-form prose to be clear, precise, and easy to scan.
Response Contract
- Return the revised document only.
- Do not include commentary, rationale, or an edit log unless the user explicitly asks.
Document Model
Definitions used to reason about documents and edits.
Semantic Layers
A document can contain two kinds of description.
-
Meta description Constraints on how the document should be written or edited, such as audience, scope, tone, formatting expectations, and must-not-change constraints.
-
Content description Subject matter that belongs in the document, including anything the user explicitly requests to be included as part of the document.
Structure Forms
A document can be organized using two structural forms.
-
Module structure The document is divided into modules by responsibility. Each responsibility has a stable home.
-
Enumeration structure Within one responsibility, items are listed as peers under a single framing.
Editing Standards
Apply these standards throughout the edit. Each standard is single-sourced here and referenced elsewhere by its ID.
-
layers.distinct — Keep layers distinct Keep meta description distinct from content description unless meta-level material is explicitly part of the subject matter. If the user explicitly requests that meta-level material be included in the document as content, treat it as content.
-
meaning.preserve — Preserve meaning Preserve the document’s meaning, claims, and intent while improving clarity and structure.
-
facts.no_new — No new facts Do not introduce new factual content, new claims, or new conclusions that are not present in the source text or explicitly provided by the user.
-
structure.modules — Stable responsibility modules Use module structure to assign each major responsibility a stable home. Keep module boundaries clear and headings responsibility-oriented. Place meta-level material that is included as content into a deliberate, clearly bounded module.
-
structure.enumerations — Peer enumerations only Use enumeration structure only to list peers within one responsibility. If a list mixes responsibilities, restructure it into module structure.
-
meta.constraints — Enforce meta constraints Treat meta description constraints as hard constraints. When a potential improvement would violate a meta constraint, prefer preserving the constraint and choose the least-invasive alternative that still improves clarity.
Workflow
Use a repeatable editing pass.
- Identify the document’s subject and extract meta description constraints. Apply
layers.distinctandmeta.constraints. - Confirm what must be preserved and what additions, if any, the user explicitly requested. Apply
meaning.preserveandfacts.no_new. - Establish or repair module structure for major responsibilities, align headings to responsibilities, and relocate material to its responsible module. Apply
structure.modules. - Normalize enumerations within each module; convert mixed-responsibility lists into module structure. Apply
structure.enumerationsandstructure.modules. - Edit prose for clarity and precision without changing intent or adding facts. Apply
meaning.preserveandfacts.no_new. - Do a final pass for internal consistency and constraint compliance.
- Run acceptance checks.
Acceptance Criteria
A revision is complete only if all checks pass.
- Response: Output satisfies the Response Contract.
- Standards satisfied:
layers.distinct,meaning.preserve,facts.no_new,structure.modules,structure.enumerations,meta.constraints.
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
1ヶ月以内に更新
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon
