Bifrost功能文档编写与审校
输入Bifrost功能名或文档路径,对照代码与配置规范编写、更新或审校文档,交付页面及导航变更。
功能与用途
适合为Bifrost新增功能编写使用指南,或维护已有文档。提供功能名称或文档路径,并说明目标读者和覆盖范围,即可获得包含界面操作、API调用、配置示例及常见问题的文档,或发现过时内容、遗漏字段和失效链接的审校结果。新建页面采用Mintlify MDX格式,可同步补充导航、关联链接和截图占位。使用时需要能访问Bifrost源码与文档目录;正式编写前需确认大纲,截图占位对应的图片需另行补充。
适用场景
- 为新功能补齐使用指南:为虚拟密钥、路由等功能编写操作与配置文档,并将新页面加入文档导航。
- 随版本变更更新文档:对照近期代码变化,修订已有页面中的界面步骤、接口说明和配置字段。
- 发布前审校配置教程:核对文档与当前实现,发现配置示例错误、字段遗漏、失效链接及缺失截图。
适用人群
- Bifrost项目维护者
- 开发者文档工程师
- 负责功能交付的研发工程师
- 开源项目技术写作者
使用步骤
- 提交功能名,或指定要更新、审校的文档路径。
- 说明目标读者、覆盖范围和需要展示的配置方式。
- 确认文档大纲、页面位置与截图需求。
- 获取文档或审校结果,检查配置示例与导航变更。
- 补齐截图并反馈需要修订的内容。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Write, update, and review Mintlify MDX documentation for Bifrost features. Explores the full codebase (UI, Go backend, config schema), validates config.json examples, places screenshot placeholders, and presents outlines for approval before writing. Invoked with /docs-writer <feature-name>, /docs-writer update <doc-path>, or /docs-writer review <doc-path>.
使用前准备
- 能够访问Bifrost项目源码、配置schema及docs文档目录。
- 编写或更新文件时,需要具备相应目录的写入权限。
- 明确功能名称或文档路径,并能确认目标读者与文档大纲。
- 了解基本API与JSON配置概念;文档中的截图占位需另行补图。