SuperAPI AI 工具集

writing

写作与研究

查看项目

更新于 10-16 08:49

技能介绍

用途:这是一套写作规范,适用于撰写或修改源码注释、pull request 概要栏、文档、wiki 等各类文本,目标是让读者对同一句话产生一致理解,避免解读偏差。

主要能力:

  1. 写出不产生解读偏差的句子。用能看出“这是坏事”的谓语来写,例如不写“pattern 变慢也不会挂”,而写“无法检测到 pattern 变慢”;目的要用完整分句说清,不用“〜用に、”这类体言止笔的片段;目的的谓语不能含糊,例如不写“为了 highlight 命中而保留 X”,而写“为了能判定 highlight 而保留 X”。
  2. 不用强调符号表达重要性。不用 bold 等强调标记,而通过词汇、断言的强度、句子位置来体现重要。
  3. 不用括号做补充说明。圆括号插入补充会让句子结构含糊;补充若是父项的细节或判断标准,展开为子列表;若是背景或理由,拆成后续句子;也可调整语序,先讲括号内容再进入正题;仅把文意反过来说的括号注记应删除。
  4. 和文与英字之间不加空格。例如写 Modalを<dialog>に,而非 Modal を <dialog> に;英文单词之间的空格保留,如 react-bootstrap Modal;Markdown 行内代码前后的空格不受此规则约束。

使用方式:在撰写、修改或评审上述文本时读取并遵循这些基准。

限制:资料未提供安装命令、代码示例、平台支持、收费方式或效果数据,暂未提供。