mcpField
P
pm-the-docs

pm-the-docs

github.com/supabase文档处理114.3k57 次安装今天更新
代码仓库

关于 pm-the-docs

帮助文档团队在起草前明确新文档工作的范围与结构,指导判断受众、产品阶段、目标、内容类型、位置和前置条件,并指出何时应请文档 PM 决策。

主要功能

  1. 01明确受众、产品阶段与目标
  2. 02选择内容类型和信息架构位置
  3. 03评估跨仓库范围
  4. 04区分已确认事实与推断
  5. 05判断何时升级给文档 PM

适用场景

  1. 01确定新文档页面或发布内容的范围
  2. 02选择页面位置及所需前置条件
  3. 03检查工作是否涉及多个产品仓库
  4. 04升级处理不明确的范围或产品阶段决策

安装

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

$npx skills add https://github.com/supabase/supabase --skill pm-the-docs

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

附带文件reference/write-the-docs-checklist.mdreference/universe-lookup.md

详细介绍

文档 PM

支持“编写文档”检查清单(镜像见 reference/write-the-docs-checklist.md)中的 Frame 和 Shape 阶段——也就是文档 PM 通常会在开始起草前确定的受众、产品阶段和跨领域范围。

何时调用

  • 开始编写新的文档页面或发布内容,需要在起草前说明产品阶段、受众和“原因”(Frame)。
  • 确定页面的内容类型、IA 位置或前置条件(Shape)。
  • 判断一次发布是否涉及多个产品仓库(CLI、Auth、迁移、平台等)——请参阅 reference/universe-lookup.md。
  • 不确定文档问题应由团队自行处理,还是需要文档 PM 签字确认。

不用于起草内容本身(请参阅 write-the-docs)、重组现有页面(请参阅 edit-the-docs)、运行代码片段(请参阅 test-the-docs),或处理 docs-app 架构/IA 位置机制(请参阅 ask-the-docs)。

参考文件

文件内容
reference/write-the-docs-checklist.md六阶段文档编写检查清单镜像
reference/universe-lookup.md跨仓库产品查找:能力门槛、universe 加速器、OSS 路径

回答范围/阶段/受众问题

  1. 阅读 reference/write-the-docs-checklist.md 中的相关阶段——其中的复选框明确列出了需要确定的事项。
  2. 阅读该功能已有的上下文:关联的 issue/project、PRD、已发布的代码或 PR。如果代码与 PRD 不一致,以代码中的行为为准。
  3. 如果范围可能涉及多个服务(CLI、Auth、迁移、Dashboard、平台等),在确定 Frame/Shape 之前,按照 reference/universe-lookup.md 中的能力门槛操作;只有在可以访问 universe 时才使用,否则使用 OSS 路径。记录你搜索过哪些仓库。
  4. 直接回答检查清单中的问题:产品阶段、受众及其待完成事项、用一句话说明“原因”、内容类型、IA 位置、前置条件。
  5. 区分已确认事实(在工单/PRD/代码中明确说明)与推断(你基于现有信息得出的最佳判断)——明确标注推断,不要将其当作定论。
  6. 如果某项决定确实尚未在组织层面确定(而非文档编写者应自行决定),请说明情况并指出应由谁决定,而不是为了让答案看起来完整而编造结论。

自行处理还是升级

如果检查清单清晰、已有标准,并且你已了解阶段和受众,就自行处理。

如果范围或阶段不明确、需要审核流程、标准含糊,或发布内容涉及跨领域界面(快速入门、API 密钥、教程、引导流程、平台概念),请升级给文档团队的 PM——详见检查清单镜像中的“询问文档 PM”完整章节。

相关技能

  • ask-the-docs — IA 位置和 docs-app 架构(Shape 阶段)。跨仓库的产品查找请使用此处的 universe-lookup.md,而不是 ask-the-docs。
  • write-the-docs — Frame/Shape 确定后起草文档
  • test-the-docs — 在 Docker 隔离的本地堆栈中运行代码片段;生成验证报告
  • edit-the-docs — 重组并改进现有页面
  • review-the-docs — 自我审查和 PR 审查阶段

评论

支持 Markdown