SuperAPI AI 工具集

wiki-page-writer

通用与其它

查看项目

更新于 10-16 00:21

技能介绍

用途:为指定组件、系统或功能生成有证据支撑的深度技术文档页,也可用于批量填充维基目录内容。

主要能力与要求:

  1. 深度标准——追踪真实代码路径而非凭文件名猜测;每条断言须标注来源(文件路径 + 函数/类名);区分事实与推断;先解释“为什么存在”再讲“做什么”,不允许含混表述。
  2. 流程——规划(按文件数确定范围、读者与文档预算)、分析(读相关文件,识别模式、算法、依赖与数据流)、写作(结构化 Markdown 加图表与引用)、校验(确认路径存在、类名准确、Mermaid 可渲染)。
  3. 强制要求——每页含 VitePress frontmatter:

title: "Page Title" description: "One-line description"

每页至少 2 张 Mermaid 图;sequenceDiagram 使用 autonumber;可选 graph、sequenceDiagram、classDiagram、stateDiagram-v2、erDiagram、flowchart;深色配色:节点填充 #2d333b、边框 #6d5dfc、文字 #e6edf3;子图背景 #161b22、边框 #30363d、线 #8b949e;内联样式用深色填充加 ,color:#e6edf3;禁止使用 <br/>(改用 <br> 或换行)。 4. 引用与结构——非平凡断言需 (file_path:line_number),每页至少引用 5 个不同源文件,证据缺失写 (Unknown – verify in path/to/check);结构为 Overview(讲 WHY)→ Architecture → Components → Data Flow → Implementation → References;API、配置与组件摘要用表格,介绍技术时用对比表,复杂代码路径可用伪代码说明。 5. 兼容性——代码块外裸泛型需转义,如 List<T>;Mermaid 块内不得出现 <br/>;十六进制颜色须为 3 或 6 位。

适用场景:需要代码级深度、可追溯来源和可视化呈现的技术维基页面编写。

限制:仅在任务与上述范围明确匹配时使用;输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。具体收费、平台支持与更多集成方式暂未提供。