mcpField
M
mvpfy-document

mvpfy-document

github.com/promovaweb文档处理8227 次安装10 周前更新
代码仓库

关于 mvpfy-document

mvpfy-document 使用模板和项目数据,将 MVP 规划信息整合为独立的 Markdown 文档,适合编写 MVP 规格说明,并包含完整性与发布质量检查。

主要功能

  1. 01按模板生成 MVP 文档
  2. 02依据项目文件重整需求分析
  3. 03标记缺失或不适用的信息
  4. 04检查并验证文档
  5. 05提供编辑与电子书发布指引

适用场景

  1. 01将 MVP 答案汇总为单一文档
  2. 02根据项目数据更新需求
  3. 03准备并验证面向用户的电子书

安装

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

$npx skills add https://github.com/promovaweb/mvpfy --skill mvpfy-document

安装后在 Claude Code 中输入/mvpfy-document确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
assets/
MVP.template.md
references/
document-rules.md
scripts/
render-company.mjs
requirements-analysis.mjs
validate-company.mjs

详细介绍

整合 MVP.md

使用 assets/MVP.template.md 作为结构来源。最终文档应为单个 Markdown 文件,无需对话历史即可理解,并包含元数据、MVP 摘要、需求分析、问题、受众、用户画像、范围、SaaS、市场、定价、成本、技术、营销、指标、执行计划和待办事项。

执行 scripts/render-company.mjs --project <diretório> 创建或更新文件。脚本通过 HTML ID mvpfy:section:<id> 定位各个章节,保留现有内容,并在缺少数据时使用“待补充”。requirements-analysis 章节会根据 .mvpfy/answers.jsonl、.mvpfy/state.json 和 .mvpfy/existing-project.json 重新生成。该章节保留每条输入的原文,并整理模块、功能、屏幕、工具、人员、数据、流程和运营需求。

requirements-specification 章节保留在模板中,作为整合结构。请根据收到的输入分析填写其子章节;它不依赖使用该模板的项目中的辅助文件。

整合时,请逐一检查适用于此人的 MVP 的子章节。将初始描述、回答、候选项目和已发现上下文中已有的细节记录到相应章节中。不要把宽泛的描述缩减成简短的功能列表。当某个主题与当前 MVP 无关时,请填写 不适用于当前 MVP;当相关主题缺少信息时,请填写 待补充,并具体说明信息缺口。

写入文件前,请使用相同的脚本并添加 --check 执行检查。之后使用 scripts/validate-company.mjs --project <diretório> 进行验证。只有填写完 SaaS MVP 的最低要求字段时,状态才能为 ready;否则请使用 preliminary 并列出信息缺口。

编辑与发布门槛

生成电子书前,请确认 docs/user/reading-order.txt 仅包含面向用户的页面。技术参考和规范仍可在线查阅,但不应纳入用户指南。 将页面结构与 Hub 的参考项目进行比较,并保持视觉风格一致,但不要照搬其文字。

请将整套页面作为一份完整出版物来阅读。改写看起来像目录、功能列表或 Agent 备注的段落。每个公开章节都需要说明情境、行动、效果和指导的适用范围。列表和表格应整理并列信息,不能取代说明文字。

编辑审阅后,请生成 PDF 和 EPUB,阅读生成结果,并运行子模块和 Hub 的验证器。构建成功只能证明文件已生成,不能证明文本质量合格。

PDF、EPUB 和清单必须使用与框架相同的 SemVer 版本。VERSION 是唯一权威版本来源,ebooks/VERSION 仅是构建时核对的副本。如果版本值不一致,请在生成或发布格式前修正版本。

请阅读 document-rules.md,了解规范顺序。

评论

支持 Markdown