生产力
write-docs avatar

write-docs

自动化 BrowserOS 功能文档的创建与维护,使用结构化且具备代码库感知的工作流程,生成精简的 Mintlify MDX 页面。

简介

write-docs 技能是一个专门的工具,旨在协助开发人员与技术写作者维护高质量、实时更新的 BrowserOS 生态系统文档。通过分析 BrowserOS 代码库(特别是位于同层目录中的服务器组件),此技能可确保功能文档准确反映当前的实作细节。它简化了技术文档的生命周期,从功能探索与代码分析,过渡到生成标准化且对读者友好的 MDX 文件,直接对接基于 Mintlify 的文档平台。

  • 自动化代码库探索:利用 Grep 和 Glob 工具导航相关功能目录,直接从源代码中提取功能需求与核心机制。

  • 结构化 MDX 生成:遵循预定义的架构产生一致且专业的文件,包含标题、描述、“运作原理”与“快速入门”等区块。

  • 整合截图工作流:提供标准化程序来撷取 UI 元素并直接储存至项目资源目录,简化视觉辅助内容的建立。

  • 导航同步:自动管理文档结构并更新 docs.json,确保新内容正确分类于网站导航层级中。

  • 实用且简洁的风格:执行文档风格指南,优先考量使用者导向的说明与实际案例,而非内部实作细节,确保文档保持简洁与可操作性。

  • 主要针对 BrowserOS 的各项功能,如 MCP 服务器、排程任务与自动化工作流程。

  • 需要本地开发环境权限以精确扫描代码库。

  • 推荐的使用方式为由用户指定功能,随后由技能提示进行必要的屏幕截图捕获。

  • 将文档长度限制为最多一页,以维持首次使用者的阅读清晰度。

  • 设计用于无缝整合现有的 BrowserOS 文档工作流,包括支持透过 mint dev 指令进行本地预览。

仓库统计

Star 数
10,719
Fork 数
1,064
Open Issue 数
83
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月30日 16:31
在 GitHub 查看