SuperAPI AI 工具集

writing

写作与研究

查看项目

更新于 10-15 12:41

技能介绍

用途

通用写作(Writing)技能面向“把已有的知识、决策、进展,变成不同读者能看懂、愿意看的文档”这一目标。它覆盖技术文档、产品文档、汇报材料等结构化文档场景,包括 spec、plan、PRD、用户手册、项目汇报、方案路演、调研报告等。

核心理念

写作不是“按模板填空”,而是“把内容装进合适的组件、组合成文档”。传统模板派先选模板,再按模板的必备章节硬塞内容;本技能先看内容形态,再挑能装这种形态的组件,自然组合。理由包括:真实内容很少正好匹配某个模板;模板的“必备章节”会让简单内容膨胀、复杂内容装不下;写作的核心判断是“这段内容长什么样、用什么组件能讲清楚”。

主要能力与资源

  • references/components.md:写作组件库(HTML / Markdown / 图示组件),是本技能最重要的索引文件。
  • references/templates/*.md:常见组合范式(spec / plan / PRD 等),是参考,不是规定。
  • references/report-template.html:浅色阅读型 HTML 报告组件示例集。
  • references/templates/report-pitch.html:深色路演型 HTML 报告组件示例集。

组件速查覆盖:Hero + Pill + TOC(一屏建立全局认知)、section-head + summary(章节扫读)、Figure(一张图说清楚)、Card-Grid(并列同质项)、VS-Block(A vs B 二选一)、表格(结构化对照)、Timeline(时间维度 / 阶段)、Decision-Card 三色(已选 / 待观察 / 风险)、Metric-Card(关键数字)、Progress-Bar(0-100% 进度)、Score-Bar(维度评分)、Callout(重要提示打断)、Badge(行内状态标注)、Chart-Container(嵌入统计图)、flow 代码块(≤ 10 节点的轻量流程)、terminal 代码块(CLI 命令演示)。

使用方式

流程分为七步:

  1. 理解内容:分析内容形态(核心表达、读者、读者读完要做什么、内容含哪些形态、篇幅预期、存放位置),判断输出格式(Markdown 或 HTML),必要时与用户对齐。
  2. 选组件:根据识别出的内容形态到 components.md 查找对应组件。原则是能用更轻的组件就用更轻的,没有对应内容就别用对应组件,单一文档内组件不要堆叠超过 8-10 种。
  3. 参考组合范式(可选):templates/*.md 提供 spec、plan、api-doc、dev-guide、prd、operation-plan、user-guide 等常见章节顺序,贴合则借鉴,只覆盖部分则删掉用不到的章节,超出则自由加章节。
  4. 素材就位:通过 Read / Grep 读取代码配置、git log 查看变更、读取 docs/ 下已有文档、用户提供或从 BI/监控获取项目数据、引用 deep-research 输出、读取 docs/decisions/ 复盘记录。素材不足时主动告知,不编造。
  5. 撰写:按“组件 + 内容”组合输出。通用准则包括中文为主、措辞精确、数据优先、结构服务内容、篇幅自适应、图表有效。按读者类型(开发者、产品/运营、用户/客户、评审人/上级)微调。HTML 报告先决定基调(浅色阅读型或深色路演型,也可混合),Read 对应组件示例 HTML 看可用类名,按 components.md 挑组件组装,调 diagram skill 生成图表,Write 输出,open 打开供 review。Markdown 文档识别内容形态后选组件,可选参考组合范式,直接写,调 preview-md skill 在浏览器预览。
  6. 质量自检:检查内容覆盖、组件适配、读者适配、信息准确、可操作性、格式规范、组件克制。发现问题直接修复。
  7. 交付:技术方案/计划/指南输出到 docs/specs/、docs/plans/、docs/guides/,调 preview-md 预览;产品文档输出到 docs/prds/、docs/guides/,调 preview-md 预览;汇报/路演/评审 HTML 输出到用户指定或 docs/reports/、docs/reviews/,同级建 assets/ 存图,写完后 open 打开 HTML。

适用场景

需要把调研结论、选型结论、对焦结论、复盘结论写成文档时;需要产出技术方案、开发计划、API 文档、开发指南、PRD、运营方案、用户手册、项目汇报、方案路演、调研报告等结构化文档时。

与其他技能的关系

deep-research → 调研结论 → writing;tech-evaluation → 选型结论 → writing;task-start → 对焦结论 → writing;task-finish → 复盘结论 → writing。writing 调用 diagram skill(生成图表嵌入文档)和 preview-md skill(Markdown 文档预览)。边界划分:deep-research 负责“搞清楚”,writing 负责“写清楚”;task-start 负责“什么时候需要写 spec/plan”,writing 负责“怎么写好”。

限制与反模式

反模式包括:先选“写哪种文档”再填模板;因为模板说“必备章节”就硬写;因为有 hero 组件就给所有 HTML 加 hero;因为有 decision-card 三色就把普通结论包成 decision;因为有 metric-card 就编数字凑指标;单一文档堆叠 ≥ 10 种组件;把“组合范式”误读为“必备模板”。

关于收费、价格、平台支持等具体信息,资料中暂未提供。