SuperAPI AI 工具集

writing-guidelines

写作与研究

查看项目

更新于 10-16 01:11

技能介绍

用途:为智能体产出的各类散文式文本提供统一写作标准,覆盖 README、文档、界面文案、错误信息、提交与 PR 文本、发布说明等。核心读者设定是忙碌且未参与工作的人,可读性优先于巧妙,清晰优先于完整。

主要规则:先给结果,首句回答发生了什么或这是什么,即读者会说“直接给 TLDR”时想要的那句,支撑细节放后面。删填充词,如 just、simply、basically、in order to、it is important to note;删掉后不改变意思的句子就删。具体优于抽象,点名文件、数字、命令,例如“把构建从 40 秒降到 9 秒”强于“更快”。用主动语态,一句一个意思,短句各带一个要点比长句带三个要点读得快。术语一致,使用项目自身词汇,同一事物始终用同一个词;存在共享语言 CONTEXT.md 时把名称与之对应(见 domain-modeling)。可读而非截断,短和清晰不同,靠删掉读者不需要的内容来变短,而不是把文字压成碎片、箭头链(A -> B -> fails)或自造缩写。

错误信息与界面文案:说明发生了什么以及下一步做什么,例如“Config not found at ./app.config.ts. Create it or pass --config <path>.”优于“Error: config missing.”。不要留死胡同,每个失败都要给出下一步。匹配产品语气,去掉感叹号和空洞热情。

应清除的 AI 腔调:破折号(em-dash、en-dash)改用带空格的连字符或句号,这是最可靠的机器写作痕迹;空洞开头如“In today's fast-paced world”“It's worth noting that”;堆叠模糊限定如“might potentially perhaps”;修辞式二元句式“Not X. But Y.”;本可用一句话表达却过度结构化的列表。

输出方式:编辑时展示收紧后的版本,并按需为每处改动给一行说明;不要用对原文的赞美来填充编辑结果。

限制:资料未提供安装命令、平台支持、收费方式或具体集成步骤,暂未提供。