用途:该技能提供编写清晰、可维护内部技术文档的最佳实践与模板,适用于 README、ADR(架构决策记录)、贡献指南等文档的撰写、重构与评审。资料提到的核心原则包括:受众意识(面向懂代码但不了解该代码存在原因的同事与未来的自己)、主动语态(如“Run npm start to start the server.”优于被动表达)、单一事实来源(注释解释“为什么”而非“是什么”)、前置上下文(把“这是什么、如何运行”放在最前面)。
主要能力与模板:README 模板包含项目/组件名称、一句话描述、前置条件(如 Node.js >= 20 等依赖)、快速开始(npm install、npm run dev)、架构说明与关键概念;ADR 模板包含短标题、状态(Proposed/Accepted/Deprecated)、日期、决策者,以及背景、决策、后果(含正面结果与负面权衡)等小节。
风格规范:标题使用句首大写(如“Getting started”);代码块始终标注语言以便高亮(如 ```typescript);选项用项目符号、步骤用编号列表;链接使用相对路径(./path/to/file)以兼容仓库浏览。
评审清单:提交前检查完整性(是否覆盖“如何运行”“如何测试”)、时效性(是否在全新终端实际运行过命令)、链接有效性、语法可读性。
限制:资料未提供该技能的安装命令、收费方式、支持平台或自动执行机制,这些信息暂未提供;其内容以文档写作规范与模板为主。