Agent Skills
› aiming-lab/MetaClaw
› technical-writing-clarity
technical-writing-clarity
GitHub指导如何撰写清晰的技术文档，包括README、技术规范和操作手册。强调目的导向、段落精简、主动语态及具体示例，提供标准结构模板，帮助工程师高效产出面向开发者的说明性文本。
Trigger Scenarios
编写README或技术规格书
创建系统运行手册或流程指南
Install
npx skills add aiming-lab/MetaClaw --skill technical-writing-clarity -g -y
SKILL.md
Frontmatter
{
"name": "technical-writing-clarity",
"category": "communication",
"description": "Use this skill when writing documentation, READMEs, technical specs, runbooks, or any text that explains a system or process to other engineers. Apply before writing any developer-facing document."
}
Technical Writing for Clarity
Principles:
- Lead with the purpose: What is this document for and who is it for?
- One idea per paragraph. Long paragraphs hide key information.
- Use active voice:
Run the scriptnotThe script should be run. - Concrete over abstract: Show an example rather than describing it abstractly.
- Avoid jargon you have not defined unless the audience definitely knows it.
Structure for runbooks/how-tos:
- Overview (1–2 sentences)
- Prerequisites
- Steps (numbered, imperative)
- Verification / expected output
- Troubleshooting
Anti-patterns: Documenting what without why, outdated examples, walls of text without headers.
Version History
- 922caf3 Current 2026-07-25 11:08
