SuperAPI AI 工具集

voice

写作与研究

查看项目

更新于 10-15 23:43

技能介绍

用途:这是一套共享的“写作声音”规范,用于指导 chalk、chalk:issue、chalk:commit、chalk:pr 等产物的撰写方式,核心是面向读者而非作者优化表达,并统一解释类内容的写法。

主要能力:给出四大写作原则——明确“为何做、为何现在做”并主动询问而非猜测;按读者任务而非身份定位受众;具体优于抽象,原始证据必须加注;先讲问题或背景。同时规定用规范语域写作、一词一义、区分过渡性内容与当前状态、杜绝营销辞令、遵循项目既有惯例而非强加。还提供解释象限的写作清单:先讲问题,再讲决策与权衡、反直觉发现、死路、范围边界和心智模型,并说明应省略哪些内容。

必要用法:行格式由产物去向决定——在渲染阅读的产物(commit 正文、issue 与 PR 描述、chalk 注释)中按段一行;在差异审阅的产物(文档页、代码注释)中按句一行,遵循语义换行。项目可覆盖此约定。写 issue、PR 或 chalk 注释前应阅读 references/palette.md;写文档页前阅读 references/docs-quadrants.md;写或改注释前阅读 chalk:code-comments;并配合 chalk:mindmap 与 chalk:goal-tree 使用。

适用场景:撰写提交正文、issue 与 PR 描述、chalk 注释、代码注释,以及文档页与解释性内容。

限制:仅覆盖解释这一象限,其他象限的写法见 references/docs-quadrants.md。简易改动(错别字、机械升级、单行配置)无需执行“为何做/为何现在做”步骤。实际效果与平台支持等资料暂未提供。