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-hant/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 下次讀這個檔案時,就會看到你的修改。

其他範本