mcpField
W
write-docs

write-docs

github.com/browseros-ai开发14.3k71 次安装今天更新
代码仓库

关于 write-docs

write-docs 是用于编写 BrowserOS 功能文档的 Agent 技能，面向文档贡献者。它涵盖代码调研、截图收集、页面编写、导航更新和预览。

主要功能

  1. 01结构化文档编写流程
  2. 02使用 Grep 和 Glob 调研代码
  3. 03截图收集指引
  4. 04创建 MDX 页面
  5. 05更新导航并预览

适用场景

  1. 01编写 BrowserOS 功能文档
  2. 02在代码库中查找实现细节
  3. 03将页面加入文档导航
  4. 04准备本地预览页面

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/browseros-ai/browseros --skill write-docs

安装后在 Claude Code 中输入/write-docs确认已加载。

详细介绍

编写 BrowserOS 文档

此技能可帮助编写 BrowserOS 功能文档。它遵循结构化工作流，以创建高质量、简洁的文档页面。

工作流

步骤 1：了解功能

开始编写文档前，先探索代码库以了解该功能：

  1. 询问用户要为哪个功能编写文档
  2. 搜索代码库中的 ../browseros-server（同级目录），查找相关代码：
    • 使用 Grep 搜索与功能相关的关键词
    • 使用 Glob 查找相关文件
    • 阅读关键文件，了解功能的工作方式
  3. 确定关键方面：
    • 此功能解决了什么问题？
    • 用户如何启用或配置此功能？
    • 主要使用场景有哪些？
步骤 2：收集屏幕截图

请用户提供用于文档的屏幕截图：

  1. 告诉用户：“请将显示[特定界面元素]的屏幕截图复制到剪贴板（Cmd+C）”
  2. 运行：python scripts/save_clipboard.py docs/images/<feature-name>.png
  3. 根据需要重复此步骤，获取其他屏幕截图
步骤 3：编写文档

在 docs/features/<feature-name>.mdx（或适当的位置）创建 MDX 文件，并遵循以下结构：

---
title: "Feature Name"
description: "One sentence describing what this feature does"
---

[Opening paragraph: 1-2 sentences explaining what the feature does and why it matters]

## How It Works

[Explain the core mechanics in 2-3 paragraphs max]

## Getting Started

[Step-by-step instructions to use the feature]

1. Step one
2. Step two
3. Step three

## [Optional: Additional Sections]

[Only if necessary - keep the doc to ONE PAGE maximum]
步骤 4：更新导航

在 docs/docs.json 的 navigation.groups 数组中，将新页面添加到相应分组下。

步骤 5：预览

告诉用户在 docs/ 目录中运行 mint dev，以预览文档。

文档风格指南

  • 简洁：最多一页
  • 清晰：面向初次使用 BrowserOS 的用户
  • 实用：重点介绍如何使用功能，而非内部实现细节
  • 直观：使用屏幕截图展示，而不只是文字说明
  • 不赘述：省略不必要的介绍或结论

示例：广告拦截文档结构

---
title: "Ad Blocking"
description: "BrowserOS blocks 10x more ads than Chrome out of the box"
---

BrowserOS ships with built-in ad blocking that works immediately—no extensions required.

## How It Works

[2-3 paragraphs explaining the mechanics]

## BrowserOS vs Chrome

[Comparison with data/screenshots]

## What This Means

[1 paragraph on the practical benefits]

关键目录

  • 文档位置：docs/
  • 图片：docs/images/
  • 功能代码：../browseros-server/（同级目录）
  • 配置：docs/docs.json

需要编写文档的核心功能

用户提到以下功能需要编写文档：

  1. BrowserOS MCP 服务
  2. 将其他 MCP 连接到 BrowserOS 助手
  3. 定时任务
  4. [在代码库中发现的其他功能]

评论

支持 Markdown