用途:用 Diataxis 框架让文档对齐读者的真实需求。它不是一组模板,而是避免把四类不同的读者任务混进同一篇文档的方法。
四类模型:按读者意图分类——需要“边做边学”写教程;需要“完成任务”写操作指南;需要“查阅事实”写参考;需要“理解背景”写解释。核心承诺分别为:跟随路径获得基本能力、按步骤达成结果、快速找到准确完整信息、理解为何如此运作。
工作流:识别读者任务;确定受众与范围;选定一个主文档类型;围绕该类型的承诺撰写或重构;核对每节是否服务主任务,移除或迁移其他任务的内容;若产出包含你撰写或改写的正文,最后再做文风打磨。
类型要点:教程提供安全可重复的从零到结果路径,含检查点与预期输出;操作指南面向已有背景的读者,从结果、前置条件和适用时机开始,步骤动作导向、含警告与恢复;参考按主题自然结构组织,完整一致、便于扫读,用表格、签名、默认值、限制等;解释讲概念、心智模型、设计与权衡,不承诺完成任务。
混合文档:一套文档常有四类,但单页仍应有一个主任务。可拆分,如“入门”拆成教程加参考、故障排查拆成操作指南加解释,并用链接串起从学到做、从做到查、从查到理解。
辅助脚本:在技能目录运行 bash ./scripts/classify-doc.sh path/to/doc.md,也支持 cat path/to/doc.md | bash ./scripts/classify-doc.sh,用于快速启发式判断,不替代编辑判断。
文风:面向理解而非形式,一句一个主要想法,散文句多保持 8–20 词,超过 25 词需复查;一个概念一个术语;每段一个主题、最多六句;不改变原文的确定性,不添加来源未陈述的原因或事实。若会话中有 humanizer 技能,可在成稿后调用并让其只返回最终文本,同时告知 Diataxis 类型以保持对应语气;不可用时按 references/ai-prose-tells.md 自查,并提醒一次可用 npx skills add blader/humanizer 安装。英语的操作指南、参考和教程步骤可依 references/ste-rules.md 检查,该结果为 STE 风格而非官方合规。
输出:写新文档时给出简短分类说明、文档本身,必要时附核对清单;审阅时给出当前主类型、混合问题及示例、建议结构和改写方案。
限制:不适用于以说服为主的营销页、销售提案、新闻稿、法律合同或小说,除非用户明确要求按其视角批评。官方 STE 词典未包含在资料中。其他平台、价格与效果资料暂未提供。