创建和编辑文档
AB Projects 中的文档是带有完整版本历史的 Markdown 页面。创建和编辑在一个带有实时预览的侧边面板中进行,每项更改都会被记录下来,因此团队始终知道更改了什么以及为什么更改。
创建页面
- 在项目的文档区域,新建一个页面。为它指定一个标题、一个可选的父路径(默认为
/— 设置类似onboarding的值以将其嵌套),以及可选的标签。 - 使用 Markdown 编写正文。编辑器会在源代码旁显示实时预览,因此您可以在输入时看到渲染结果。
- 保存以将页面发布到树中。它会成为版本 1。
编辑页面
- 打开一个页面并选择编辑(从页面的操作菜单中)。同一个面板会打开并显示当前的 Markdown。
- 编辑时必须填写编辑备注。在保存更改之前,您必须输入一条简短的备注来描述更改了什么 — 如果您将其留空,AB Projects 会要求您添加一条,“以便您的团队知道更改了什么”。(新页面不需要备注;编辑则需要。)
- 保存会创建一个新版本,而不是覆盖 — 先前的版本会被保留。
版本历史与恢复
- 每个页面都会跟踪一个版本号以及最后的编辑者和时间。
- 从页面的操作菜单中打开历史记录,查看过去的版本,每个版本都带有其编辑备注 — 因此每项更改的“原因”都有记录。
- 您可以从历史记录列表中恢复到较早的版本。恢复会将该内容作为当前页面带回(其本身也会被记录为一个新版本)。
删除页面
- 删除可从页面的操作菜单中使用,它特意与编辑/历史记录分开放置,以免被意外点击。
- 删除会将页面从树中移除。请将其视为一项需要谨慎的操作 — 当您只是需要更改内容时,优先选择编辑或恢复,而不是删除。
提示
- 使用父路径来构建清晰的结构(例如
engineering/runbooks),而不是页面的扁平列表。 - 编写有意义的编辑备注 — 它们是历史记录所显示的内容,也是队友无需进行差异比对即可理解更改所依赖的内容。
- 在保存之前,使用实时预览检查格式(标题、代码块、链接)。
- 如果某次编辑出错,请从历史记录中恢复先前的版本,而不是凭记忆重写。
借助 Markdown、实时预览、强制性编辑备注以及带恢复功能的完整历史记录,文档保持易于编写且更改安全。