Skip to content

文档状态管理

每篇文档通过 Front Matter 中的 status 字段标记当前生命周期状态。

状态定义

状态标识说明何时使用
草稿draft草稿,内容未完成刚创建、正在编写中
审核中review审核中,等待校对初稿完成,需要他人审阅
已发布published已发布,内容已定稿审阅通过,正式对外
已废弃deprecated已废弃,内容过时技术栈升级、方案已不再适用

使用方式

在文档 Front Matter 中添加 status 字段:

yaml
---
title: Flink 架构原理
status: published
---

筛选与统计

通过状态字段可以快速:

  • 筛选所有「草稿」文档,集中完善
  • 统计各分类的完成度
  • 识别「已废弃」文档,决定是否需要归档
bash
# 查找所有草稿文档
grep -r "status: draft" docs/

状态流转

draft → review → published
  ↓                 ↓
  └──→ deprecated ←─┘
  1. 新建文档默认为 draft
  2. 内容完成后进入 review
  3. 审阅通过后标记为 published
  4. 内容过时或方案废弃后标记为 deprecated

基于 VitePress 构建