SuperAPI AI 工具集

write-docs

写作与研究

查看项目

更新于 10-15 20:08

技能介绍

用途:为 BrowserOS 功能创建或更新文档。

主要能力:按结构化流程调研代码库、收集截图、撰写 MDX 文档并更新导航配置。

使用方式:

  1. 理解功能:向用户确认要记录的功能,在相邻目录 ../browseros-server 中用 Grep 搜索关键词、用 Glob 查找文件并阅读关键代码,弄清该功能解决的问题、启用与配置方式及主要用例。
  2. 收集截图:提示用户将截图复制到剪贴板,然后运行 python scripts/save_clipboard.py docs/images/<feature-name>.png,按需重复。
  3. 撰写文档:在 docs/features/<feature-name>.mdx 创建 MDX,包含 frontmatter 的 title、description,以及开头段落、How It Works、Getting Started、可选章节,全文不超过一页。
  4. 更新导航:将新页面加入 docs/docs.json 的 navigation.groups 数组对应分组。
  5. 预览:让用户在 docs/ 目录运行 mint dev。

风格要求:简洁(最多一页)、面向首次使用者、侧重使用方法而非内部实现、多用截图、无冗余内容。

关键目录:文档 docs/,图片 docs/images/,功能代码 ../browseros-server/,配置 docs/docs.json。

待记录功能:BrowserOS MCP Server、将其他 MCP 连接到 BrowserOS 助手、定时任务,以及代码库中发现的其他功能。

限制:资料未提供收费、价格、平台支持范围等信息。