Clear Writing

✨ Clear Writing

Clear Writing

收藏
6.3k
安装
1.9k
版本
0.1.0
CLS 安全性认证2026-07-14
点击查看完整报告 >

使用说明

安全解读

核心功能

Clear Writing 是一套面向开发者的技术写作技能,整合了 William Strunk《风格的要素》经典写作规则与现代技术文档范式(Divio 框架),覆盖从 README、API 文档到提交信息、错误提示等各类面向人类的文本场景。

核心能力矩阵:

| 维度 | 覆盖内容 |
|------|---------|
| 写作原则 | Strunk 18 条基础规则,强调主动语态、肯定陈述、具体语言、删减冗词 |
| 文档类型 | README、Tutorial、How-to、Reference、Explanation、Architecture Doc |
| 结构模式 | 倒金字塔结构、问题-解决方案、顺序步骤 |
| 反模式规避 | AI 八股词汇检测(pivotal/crucial/seamless/delve 等)、过度格式化警示 |
| 代码示例规范 | 完整可运行、渐进复杂度、语言标注、当前版本可用 |
| 受众适配 | 初学者/中级/专家三级语境控制 |

显著优点:

1. 权威性来源:基于百年验证的 Strunk 经典与 Divio 文档框架,非个人臆断
2. 实操性极强:提供可直接套用的 README 模板、API 文档结构、评审检查清单

3. AI 时代特化:专门识别并纠正常见 LLM 生成文本的统计回归特征(空泛动名词短语、促销形容词堆砌)

4. 上下文优化:支持"有限上下文策略",可通过子代理加载单篇参考文件(约 1,000–4,500 tokens)替代完整技能

潜在局限:

  • 纯英文写作导向,中文技术文档需本地化适配
  • 侧重"清晰"而非"风格多样",创意写作场景覆盖有限
  • 依赖人工判断执行,无自动化强制校验机制

适合人群:

  • 开源项目维护者(撰写 README、贡献指南)
  • 技术文档工程师(构建文档体系)
  • 全栈开发者(API 文档、错误信息设计)
  • 非技术背景产品经理(需输出技术场景文案时)

常规风险:

  • 过度删减导致语气生硬或信息缺失
  • 严格遵循规则可能抑制必要的修辞灵活性
  • 模板化套用造成文档同质化

Clear Writing 内容

references文件夹
elements-of-style文件夹
手动下载zip · 74.8 kB
01-introductory.mdtext/markdown
请选择文件