跳转到内容

使用文档

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

在项目侧边栏选择 Documents,即可看到项目的文档以卡片网格呈现,每张卡片显示标题、类型和版本。一排筛选标签让你按类型收窄列表,包括 PRDSpecDesignNoteReportOther,不属于这些类型的文档会归入 Other。用 New Document 手动新增一份。

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

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

打开一份文档,在它的页面上阅读 Markdown 正文。选择 Edit 修改内容,用 Save Changes 保存,每次保存都会推进版本。侧边栏显示文档的详情、它的 Source Proposal(设置了来源时带链接指向来源提案)以及 Version History。内容下方的评论区供你讨论。

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

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

报告是类型为 Report 的文档。它们和其他文档一样出现在列表里、可用 Report 筛选;同时,完成报告还会按想法聚合:一个想法的概览会把它的报告汇总起来,让你在一个地方读到该想法的成果。

用户或超级管理员可以用具破坏性的 Delete 按钮删除文档。删除是永久性的,所以在确认前务必确认删对了文档。

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