用途:为文档类交付物提供统一写作、编辑与审阅标准。文档指任何散文交付物,如 README、规格、规则、技能、设计文档、指南、评审和发布说明;该规范不管理普通对话,只管交付物本身。\n\n主要能力:规则分为两组,每次文档任务都需同时应用。references/common/source-to-deliverable.md 说明如何把来源(阅读过的代码或进行过的讨论)转化为交付物,而不把来源直接搬进输出。references/common/anti-slop.md 列出使文档读起来像机器堆砌填充内容的模式,每条附规则代码与修正方法。文档内所有路径相对于 SKILL.md,可在任意安装位置解析。\n\n使用方式:第 0 步(可选,每会话一次)引导提醒钩子,先运行只读检查 python3 <skill-dir>/bootstrap.py --verify;退出码 0 表示钩子已接好,非零则运行 python3 <skill-dir>/bootstrap.py 进行接入,它会自动检测作用域并合并 SessionStart 与 UserPromptSubmit 两个条目,不干扰已有钩子;需让用户重启会话使钩子生效。第 1 步可选细化文档类型,若 references/<doc-type>/ 下存在对应指南则一并阅读,否则通用规则即为全部标准。第 2 步读取两份通用参考后撰写、编辑或审阅文档。\n\n该技能要阻止两类失败:一是照搬来源,把读到的代码、函数名或刚讨论的示例粘贴进交付物;来源只用于学习,不应出现在输出中。二是 slop,包括模糊措辞、夸大宣传、清嗓子式废话、加油助威、反射式标题与加粗列表,以及听起来有内容却无实质的句子。审阅文档时,按规则代码报告违规,附上违规行与修正方法,方式类似 coding-standards 报告代码评审。\n\n限制:未提供具体每条规则的完整清单、各文档类型指南明细、钩子实现细节及适用平台说明;路径与命令依赖安装位置。
writing-standards
写作与研究
更新于 10-16 03:39