Storybook文档审校与改写
读取Storybook文档草稿或新功能说明,梳理页面结构、改写说明与示例,产出修订文档或内容规划。
功能与用途
面向Storybook项目的文档维护与编写,支持审阅现有页面、重写混乱草稿、起草新功能文档,以及制定页面规划。提供文档路径、草稿或功能说明后,可调整内容顺序、补充解释、改进示例,并统一标题、链接和页面格式。编辑结果可包含文档及其配套代码片段的修改和检查结果;规划结果包含目标读者、页面大纲与拆分合并建议。适用范围限于项目的/docs目录,实际修改和检查需具备仓库访问及运行条件。
适用场景
- 改进难读的功能说明:审阅/docs中的现有页面,调整说明顺序、补足概念解释,改进读者难以照做的示例。
- 编写新功能文档:提供新功能说明和目标读者,产出符合页面用途与Storybook格式规范的文档。
- 规划页面拆分:为混杂概念、操作和配置说明的页面设计大纲,明确保留内容及拆分合并建议。
- 修正文档格式问题:修复链接、提示块、标题与页面元信息等问题,并运行项目文档检查。
适用人群
- Storybook文档维护者
- 开源项目贡献者
- 技术写作者
- 前端开发者
使用步骤
- 提供文档路径或功能说明,说明需要审阅、改写、新写或规划。
- 确定目标读者和页面主要用途。
- 获取结构调整、文案与示例修改,或页面规划方案。
- 编辑后统一文档格式并运行检查,修复发现的问题。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Review, improve, rewrite, author, or plan Storybook documentation in /docs. Use this when asked to review docs, improve a page, rewrite documentation, draft new docs, or advise on docs strategy.
使用前准备
- 提供待审阅的文档路径、草稿,或新功能说明及目标读者。
- 实际编辑需能访问Storybook仓库中的/docs及相关文档代码片段。
- 完整执行需具备Skill引用的文档规范文件,以及运行项目文档检查命令的环境。