文档元数据规范
所有新建正式文档必须使用 Markdown Front Matter。
必填字段
---
doc_id: PRD-202606-001
feature_id: FEAT-202606-001-unified-entry-client
type: prd
title: 统一入口客户端需求说明
status: draft
owner: 张三
created_at: 2026-06-16
updated_at: 2026-06-16
---
推荐字段
reviewers:
- 李四
related_docs:
- DES-202606-001
related_modules:
- emoon-openplatform
- emoon-admin
tags:
- 统一入口
- 终端客户端
supersedes:
superseded_by:
source:
字段说明
| 字段 |
必填 |
说明 |
doc_id |
是 |
单篇文档唯一编号 |
feature_id |
否 |
所属需求、项目、专题;非专题类文档可为空 |
type |
是 |
文档类型,取值见 doc-taxonomy.md |
title |
是 |
文档标题 |
status |
是 |
生命周期状态 |
owner |
是 |
当前负责人 |
created_at |
是 |
创建日期,格式 YYYY-MM-DD |
updated_at |
是 |
最近实质更新日期,格式 YYYY-MM-DD |
reviewers |
否 |
评审人 |
related_docs |
否 |
关联文档 doc_id 列表 |
related_modules |
否 |
关联代码模块 |
tags |
否 |
检索标签 |
supersedes |
否 |
当前文档替代的旧文档 |
superseded_by |
否 |
替代当前文档的新文档 |
source |
否 |
来源链接、会议、外部资料 |
状态
| status |
含义 |
draft |
草稿 |
reviewing |
评审中 |
approved |
已确认 |
implemented |
已实现或已落地 |
deprecated |
已废弃 |
superseded |
已被其他文档替代 |
规则
- 标题不承载编号、日期和状态,这些信息放在 Front Matter。
doc_id 一旦发布,不应复用给其他文档。
- 文档发生实质内容变更时必须更新
updated_at。
- 废弃文档不删除,改为
deprecated 或 superseded,并说明替代文档。
- 涉及接口、架构边界、鉴权、脱敏、模块依赖的变更,必须补充关联文档。