developer-docs-editing-review
Edit and review developer documentation for technical accuracy, completeness, structure, clarity, brevity, peer feedback, technical review, technical verification, QA procedure testing, and feedback integration. Use when reviewing, editing, refactoring, or preparing developer docs for release, especially docs with procedures, examples, prerequisites, or high-risk technical claims.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- developer-docs-editing-review
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,editing,review", "version": "0.1.0", "category": "Writing", "displayName": "Developer Docs Editing Review" }
- description
- Edit and review developer documentation for technical accuracy, completeness, structure, clarity, brevity, peer feedback, technical review, technical verification, QA procedure testing, and feedback integration. Use when reviewing, editing, refactoring, or preparing developer docs for release, especially docs with procedures, examples, prerequisites, or high-risk technical claims.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 4
- 参考文档guidelines.md1.7 KB
- 参考文档references/core/knowledge.md8.3 KB
- 参考文档workflows/edit-developer-doc.md2.2 KB
- 参考文档workflows/verify-technical-doc.md2.8 KB
03 SKILL.md 正文
Developer Docs Editing Review
Use this skill to improve developer documentation after a draft exists. It treats editing as validation and refactoring: check whether the doc is accurate, complete, structured, clear, brief, and reviewable.
This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 4, "Editing documentation." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 15, "Technical Editing," and Chapter 16, "Technical Verification." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Identify doc type, audience, source of truth, and release risk.
- Use separate passes for technical accuracy, completeness, structure, clarity, and brevity.
- Use
workflows/verify-technical-doc.mdwhen procedures, migrations, security, data, or production changes need formal verification. - Use
workflows/edit-developer-doc.mdfor a full edit. - Return findings first when the user asks for a review; return revised text when the user asks for an edit.
Default Output
When reviewing documentation, return:
- Findings - ordered by reader risk, with file/section references when available.
- Missing validation - commands, examples, screenshots, API facts, or source claims not checked.
- Verification route - self-test, SME review, QA test, or release blocker.
- Recommended edits - exact changes or rewrites.
- Review routing - who should validate technical details.
- Residual risk - assumptions that remain after the edit.
When editing directly, return the revised doc plus a brief change summary and unresolved questions.
Contents
| Need | Start Here |
|---|---|
| Understand editing passes | references/core/knowledge.md |
| Apply review rules | references/core/knowledge.md |
| See examples of edits and feedback | references/core/knowledge.md |
| Run a full edit | workflows/edit-developer-doc.md |
| Verify risky technical docs | workflows/verify-technical-doc.md |
| Route by task | guidelines.md |
Core Posture
- Separate writing from editing; do not polish around an unverified flaw.
- Prioritize reader-impacting errors over style preferences.
- Ask for specific reviews from the right technical owners.
- Treat high-risk procedures as release-blocking until verified or explicitly accepted.
- Integrate feedback by user need, not by reviewer rank or comment volume.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.