MarsDawn 已在 Mac App Store 上架

Markdown 规格文档(PRD)模板

一份 agent 能填、你一次就能读完的规格文档:问题、目标、需求、流程图和验收标准。改了一条需求,就请 agent 把其他部分跟着改好。

模板

下载 spec.md

# 规格:功能名称

状态:草稿 · 负责人:姓名 · 更新:日期

## 问题

_现在哪里有问题、影响谁、我们怎么知道。_

## 目标

- _上线后应达成的结果。_

## 不做的事

- _这次刻意不做的事。_

## 需求

| 编号 | 需求 | 优先级 |
|------|------|--------|
| R1 | _需求_ | 必须 |
| R2 | _需求_ | 应该 |

## 流程

```mermaid
flowchart LR
  A[开始] --> B[步骤] --> C[结果]
```

## 验收标准

- [ ] R1:_怎么确认。_
- [ ] R2:_怎么确认。_

## 待定问题

- _问题。_

导出效果

spec.md 用 marsdawn export 导出的 PDF 第一页。

用 marsdawn export spec.md 导出。免费的命令行工具排版和 MarsDawn 的预览一样,图表也一起画出来。

交给 agent

用 https://marsdawn.southern-light.dev/zh-hans/templates/spec/spec.md 这份模板,把[功能]的规格写进 spec.md。每条需求都要有编号,流程图和验收标准用同样的编号。写好之后运行 marsdawn open spec.md。

导出 PDF 分享

marsdawn export spec.md 会在旁边写出 spec.pdf,给不读 Markdown 的人。

做不到的事

MarsDawn 会显示规格、表格和流程图,但不会检查验收标准有没有覆盖每一条需求。那是 agent 的工作,也要靠你读。

常见问题

流程图需要另外安装什么吗?

不用。MarsDawn 和 marsdawn export 自己就会画 Mermaid,离线也能画。

可以在 MarsDawn 里改规格吗?

可以。它是 Markdown 编辑器,源代码旁边就是预览。agent 下次读这个文件时,就会看到你的修改。

其他模板