SuperAPI AI 工具集

wiki-page-writer

写作与研究

查看项目

更新于 10-15 10:24

技能介绍

用途

Wiki Page Writer 是一个技术文档生成技能,角色设定为“资深文档工程师”,用于产出具有证据深度的综合技术文档页面。

适用触发场景包括:

  • 用户要求为某个特定组件、系统或功能编写文档
  • 用户希望获得带有图表的技术深度剖析
  • 需要为 wiki 目录章节生成内容

主要能力

该技能对文档深度提出了若干不可妥协的要求:

  • 追踪真实代码路径:不依据文件名猜测,需阅读实现代码
  • 每项论断都需要来源:文件路径 + 函数/类名
  • 区分事实与推断:若阅读了代码应说明,若为推断需标注
  • 第一性原理:在解释“做什么”之前先解释“为什么存在”
  • 拒绝含糊其辞:不写“这大概率处理了……”而应阅读代码

使用方式

该技能遵循以下流程:

  1. 计划:根据文件数量确定范围、受众与文档预算
  2. 分析:读取所有相关文件,识别模式、算法、依赖与数据流
  3. 撰写:生成带图表与引用的结构化 Markdown
  4. 校验:验证文件路径存在、类名准确、Mermaid 可正确渲染

强制要求

VitePress Frontmatter:每个页面必须包含 title 与 description 字段。

Mermaid 图表:每页至少 2 个;所有 sequenceDiagram 块使用 autonumber;可选用 graph、sequenceDiagram、classDiagram、stateDiagram-v2、erDiagram、flowchart 等类型;强制使用深色模式配色(节点填充 #2d333b、边框 #6d5dfc、文本 #e6edf3;子图背景 #161b22、边框 #30363d、连线 #8b949e);若使用内联 style,需使用深色填充并配合 ,color:#e6edf3;禁止使用 <br/>(改用 <br> 或换行)。

引用:每项非平凡论断需标注(file_path:line_number);每页至少引用 5 个不同的源文件;若缺失证据,标注(Unknown – verify in path/to/check)。

结构:概述(解释为什么)→ 架构 → 组件 → 数据流 → 实现 → 参考。对 API、配置与组件摘要使用 Markdown 表格;引入技术时使用对比表格;解释复杂代码路径时包含熟悉语言的伪代码。

VitePress 兼容性:在代码围栏外转义裸泛型,如 List<T> 而非裸 List<T>;Mermaid 块中禁用 <br/>;所有十六进制颜色必须为 3 或 6 位。

适用场景

该技能适用于执行其概述中描述的工作流或操作,主要面向需要生成高质量、可溯源技术文档的工程与文档场景。

限制

资料中未提供关于收费、价格、平台支持范围或具体效果的信息,暂未提供相关内容。