clear-writing

✍️ 技术文档写作权威指南

🥥86总安装量 20评分人数 23
100% 的用户推荐

融合Strunk经典写作规则与Divio文档框架,提供技术文档、README及API文档的结构化写作指南,助力打造清晰专业的技术内容。

A

基本安全,请在特定环境下使用

  • 来自社区或个人来源,建议先隔离验证
  • ✅ 纯 Markdown 文档资产,无可执行代码或脚本文件,零代码执行风险
  • ✅ 无网络请求、无数据收集、无本地文件上传,隐私安全性完全合规
  • ✅ 所有内嵌代码均为文档示例,经检测不含 eval()/exec()/system() 等危险函数
  • ⚠️ 来源为个人开发者账号(T3级别),虽内容可信但建议关注后续维护更新
  • ✅ 无外部依赖声明,无动态代码加载,权限申请与功能描述完全匹配

使用说明

Clear Writing 是一款专注于技术写作与文档编写的结构化指南技能,旨在帮助用户产出清晰、简洁、专业的技术文档。该技能系统整合了William Strunk Jr.《风格的要素》经典写作法则、Divio文档分类框架以及现代技术文档最佳实践,形成了一套完整的写作方法论体系。

核心用法
该技能适用于所有面向人类读者的文本创作场景,包括但不限于技术文档、README文件、API文档、教程指南、提交信息、错误提示、UI文案及各类报告。其核心工作流围绕"撰写-审查-优化"展开:用户首先基于Strunk规则(主动语态、肯定句式、具体语言、删减冗词)起草内容,随后参照Divio框架选择适当的文档类型(教程、操作指南、参考文档或解释说明),最后通过内置的审查清单验证文档的准确性、完整性和可读性。对于上下文受限场景,技能还支持分派子代理进行专项编辑的协作模式。

显著优点
首要优势在于其权威性与实用性并重,将百年经典写作原则与现代软件文档实践相结合,既提供了"省略 needless words"等具体可执行的写作规则,又给出了README模板、API文档结构等即拿即用的工具模板。其次,技能特别针对AI写作痛点,系统梳理了"pivotal"、"delve"、"seamless"等陈词滥调清单,有效帮助用户避免生成式模型常见的浮夸文风。此外,其受众适配框架(初学者/中级/专家)和详细的代码示例规范(完整可运行、渐进式复杂度)确保了文档的实用性和包容性。

潜在缺点与局限性
作为纯静态文档型技能,Clear Writing 仅提供写作规范与模板参考,不具备自动化生成或实时校验功能,所有改进建议仍需人工实施。其次,其核心内容基于英文写作经典(Strunk's Elements of Style),虽技术文档原则具有普适性,但部分语法规则和表达习惯可能更适用于英文语境。此外,技能来源为个人开发者(T3级别),虽内容质量经审核可靠,但长期维护更新频率及社区支持规模相较于企业级产品可能存在不确定性。

适合的目标群体
该技能特别适合软件开发工程师、技术文档工程师、产品经理、开源项目维护者以及需要撰写技术博客、API文档或用户手册的内容创作者。对于希望提升技术写作专业度、避免常见文档反模式(如"文字墙"、过时文档、知识假设过高)的初学者,以及需要标准化团队文档规范的技术负责人具有直接价值。

使用风险
作为纯Markdown文档资产,该技能不存在代码执行、网络通信或数据隐私风险。所有内嵌代码均为静态示例,不含危险函数调用。主要风险在于文档示例中的命令或代码片段若被直接复制使用,需用户自行验证其适配性与安全性,但这属于常规的技术文档使用风险,非技能本身缺陷。建议用户在使用安装命令示例时保持常规安全意识。

clear-writing 内容

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