鱼皮AI导航
鱼皮AI导航
  • 主页
  • 社区
  • AI工具
  • AI知识库
  • AI提示词
  • MCP
  • Skills
  • AI学习资源
  • AI资讯
  • GitHub开源
登录/注册

write-docs

面向 BrowserOS 功能文档的自动化编写能力,通过分析服务端代码理解功能逻辑,结合用户提供的界面截图,生成符合 Mintlify 规范的 MDX 文档,并自动更新导航配置,确保文档简洁实用、面向终端用户。

效率工具文档处理软件开发
访问 GitHub
文档Skills.MD
name
write-docs
description
Write BrowserOS feature documentation. Use when the user wants to create or update documentation for a BrowserOS feature. This skill explores the codebase to understand features and writes concise Mintlify MDX docs.
allowed-tools
Read, Grep, Glob, Bash, Task, Write, Edit

Write BrowserOS Documentation

This skill helps write documentation for BrowserOS features. It follows a structured workflow to create high-quality, concise documentation pages.

Workflow

Step 1: Understand the Feature

Before writing documentation, explore the codebase to understand the feature:

  1. Ask the user which feature they want to document
  2. Search the codebase at ../browseros-server (sibling directory) to find relevant code:
    • Use Grep to search for feature-related keywords
    • Use Glob to find relevant files
    • Read key files to understand how the feature works
  3. Identify key aspects:
    • What problem does this feature solve?
    • How does the user enable/configure it?
    • What are the main use cases?

Step 2: Gather Screenshots

Ask the user to provide screenshots for the documentation:

  1. Tell the user: "Please copy a screenshot to your clipboard (Cmd+C) that shows [specific UI element]"
  2. Run: python scripts/save_clipboard.py docs/images/<feature-name>.png
  3. Repeat for any additional screenshots needed

Step 3: Write the Documentation

Create the MDX file at docs/features/<feature-name>.mdx (or appropriate location) following this structure:

▼
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]

Step 4: Update Navigation

Add the new page to docs/docs.json under the appropriate group in the navigation.groups array.

Step 5: Preview

Tell the user to run mint dev in the docs/ directory to preview the documentation.

Documentation Style Guide

  • Concise: Maximum one page length
  • Clear: Write for first-time BrowserOS users
  • Practical: Focus on how to use the feature, not internal implementation details
  • Visual: Use screenshots to show, not just tell
  • No fluff: Skip unnecessary introductions or conclusions

Example: Ad Blocking Doc Structure

▼
mdx
复制代码
--- 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]

Key Directories

  • Docs location: docs/
  • Images: docs/images/
  • Feature code: ../browseros-server/ (sibling directory)
  • Config: docs/docs.json

Core Features to Document

The user mentioned these features need documentation:

  1. BrowserOS MCP Server
  2. Connecting other MCPs to BrowserOS assistant
  3. Scheduled tasks
  4. [Additional features discovered in codebase]
效率工具
文档处理
软件开发

快捷安装

复制到终端去安装 Skill

npxskillsaddbrowseros-ai/BrowserOS--skill"write-docs"
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
站长:程序员鱼皮 老鱼简历 商务合作 增值电信业务经营许可证
2026 鱼皮AI导航 | 沪ICP备19026706号-6
🔥热门工具
朱雀AI检测朱雀AI检测
朱雀AI检测助手朱雀AI检测助手
LovartLovart
老鱼简历老鱼简历
WritePass官网WritePass官网
面多多面多多
CursorCursor
星月写作星月写作
朱雀AI检测助手朱雀AI检测助手
零感AI零感AI
Skills 推荐
debug
debug 是一个系统化定位软件缺陷根因的技能,适用于用户报告 'fix'、'broken'、'error' 等问题或测试意外失败时。它通过可验证的假设、最小复现、因果链分析和回归测试,确保在修复前准确定位根本原因。
retrieving-developer-knowledge
retrieving-developer-knowledge 用于搜索、获取和整合 Google 官方开发者文档,覆盖 Google Cloud、AI/Gemini、Android、Chrome、Web、Flutter、Go、Firebase 等平台,适用于查询 gcloud CLI 命令、API 语法、IAM 权限或架构对比等场景。
diff-intake
diff-intake 读取 PR 或分支差异,生成结构化 YAML 变更摘要,用于下游 analytics instrumentation 技能。适用于用户提交 PR 链接、分支对比或原始 diff 后需理解变更内容、评估分析覆盖或启动埋点流程的场景。
webapp-testing
提供本地 Web 应用的端到端测试能力,支持页面导航、元素交互、表单填写、动态等待、断言验证、截图捕获、浏览器日志收集及网络请求拦截,适用于前端功能验证与 UI 行为调试。
definition-of-done-generator
自动生成项目完成标准的规范定义与配置文件,提供符合企业级工作流要求的最佳实践指导,输出可直接投入生产环境的代码和验证结果,适用于需要标准化流程审批、合规审查及跨系统集成的复杂项目管理场景。