跳转到内容

使用文档

文档是一个项目的书面产物,包括 PRD、规格、设计、笔记以及总结报告。大多数文档在你批准提案时自动生成,但你也可以手动创建。本页讲述文档列表、创建与编辑文档、版本历史、报告如何出现,以及如何删除文档。

在项目侧边栏选择文档,即可看到项目的文档以卡片网格呈现,每张卡片显示标题、类型和版本。一排筛选标签让你按类型收窄列表,包括 PRD、技术规格、设计文档、笔记、总结报告和其他,不属于这些类型的文档会归入其他。如需手动添加文档,请使用新文档。

带类型筛选标签的文档列表,文档卡片显示类型徽章和版本
文档列表把批准提案产生的文档和报告放在一起;可按类型筛选。

选择新文档,填写标题和类型,也可以附加一个 Markdown 文件(.md、.txt 或 .markdown)作为初始内容。不带文件创建时,会得到一份空文档,你可以在它的页面里填写。

打开一份文档即可阅读其内容。选择编辑修改内容,用保存更改保存,每次保存都会推进版本。侧边栏显示文档的详情、它的来源提案(设置了来源时带链接指向该提案)以及版本历史。正文下方的评论区可用于讨论。

如果 Markdown 正文以受支持的 YAML frontmatter 开头,Chorus 会在正文上方用元数据卡片显示这些字段。例如:

---
title: CSV 导出
status: draft
---
## 需求
用户可以导出当前结果集。

使用扁平的 key: value 字段,第一行必须是 ---,以 --- 或 ... 结束。块内允许空行和 # 注释。 这不是完整的 YAML 支持,不支持嵌套对象、列表和多行值。无法识别该块时,Chorus 会按原始 Markdown 渲染。

卡片只改变显示方式,不会改变文档类型、工作流状态、存储的正文或导出内容。Spec-lite 用 frontmatter 将每份变更文档关联到提案和持久文档。

文档以两种方式进入这个列表:

  • 来自批准的提案。 当你批准一份提案时,它的每个文档草稿都会转为一份真实的文档出现在这里;批准会创建什么见审核提案。
  • 手动创建。 上面的新文档对话框。

总结报告是一种文档类型。这类文档和其他文档一样出现在列表里,可用总结报告标签筛选;此外,总结报告还会按想法汇总:在一个想法的概览中可以集中阅读它的所有报告,了解该想法的成果。

用户或超级管理员可以用删除按钮删除文档。删除不可恢复,确认前请核对要删除的文档是否正确。

文档是工作流的产物之一。想了解它们如何从计划中产生,请读审核提案;想跟进它们所描述的工作,见执行任务。完整的状态模型见实体生命周期参考。