SuperAPI AI 工具集

software-manual

写作与研究

查看项目

更新于 10-15 17:32

技能介绍

用途:为软件生成交互式单文件 HTML 使用手册,采用 TiddlyWiki 风格,内含截图、API 文档和多级代码示例。

主要能力:内容分 6 个并行子代理产出——overview(产品简介、功能、快速开始)、ui-guide(界面操作与分步指南)、api-docs(REST 与前端 API)、configuration(环境变量、部署、设置)、troubleshooting(FAQ、错误码、解决方案)、code-examples(初级/中级/高级示例)。成品 HTML 支持全文搜索与结果高亮、分节折叠/展开、标签导航、明暗主题切换(localStorage 持久化),所有 CSS/JS/图片以 Base64 内嵌,可离线使用,并带打印优化样式。

执行流程分 6 阶段:需求收集(输出 manual-config.json)、项目探索(cli-explore-agent 并行产出 exploration-.json)、API 提取(extract_apis.py,支持 FastAPI/TypeDoc/pdoc)、6 代理并行分析(产出 sections/section-.md)、整合质检(consolidation-summary.md、screenshots-list.json)、截图采集(Chrome MCP 的 mcp__chrome__screenshot,产出 screenshots/.png)、HTML 组装({name}-使用手册.html)、迭代优化(iterations/v.html)。

使用方式:主 Agent 编排、子 Agent 执行;子 Agent 仅返回路径与摘要(摘要不超过 50 字符)以避免上下文溢出。工作目录为 .workflow/.scratchpad/manual-{timestamp}/,内含 manual-config.json、exploration/、sections/、api-docs/、screenshots/、iterations/ 等子目录。

限制:具体安装命令、调用命令、收费与价格信息暂未提供;实际效果取决于目标项目的可探索性与截图环境,本资料未给出性能或质量保证。