页面模板与标准化文档结构
1. 标准 VitePress frontmatter
建议所有新增或修订页面都先补齐以下 frontmatter:
yaml
---
title: 文档标题
description: 一句话描述(50-160字)
editor: Azek431
status: 已整理 / 持续扩展中 / 深度整理
difficulty: 入门 / 进阶
evidence: E1(已确认)/ E2(截图直接证据)/ E3(多来源交叉归纳)
updated: 2026-05-16
category: 分类
version: v0.2.x
tags:
- 标签1
- 标签2
---2. 旧版正文元信息(已废弃,仅作历史参考)
以下格式为旧版文档元信息写法,现已迁移到 VitePress frontmatter。仅作历史参考,新建文档请使用上方 frontmatter 格式。
md
- 文档标题:
- 分类:
- 子系统:
- 关键词标签:
- 来源类型:
- 证据等级:
- 完整度状态:
- 版本号:
- 来源文件:
- 来源截图编号:
- 最后更新:
- 适合查询:
- 关联文档:核心内容结构
页面正文建议按照以下结构排布:
- 简要介绍(目的、适用对象、关键结论)
- 当前问题 / 研究范围
- 核心知识点或步骤
- 示例与实战建议
- 关联文档与后续补充
- 证据与来源说明
页面类型区分
教程型页面
- 适合场景:操作步骤、学习路线、实战指南。
- 结构建议:目标、步骤、注意事项、实战案例。
- 证据等级:官方说明 / 多来源交叉归纳。
研究型页面
- 适合场景:机制分析、版本演进、OCR 证据回链。
- 结构建议:背景、结论、证据、结论等级、待验证问题。
- 证据等级:截图直接证据 / 多来源交叉归纳 / 待验证。
维护型页面
- 适合场景:维护规范、贡献指南、部署方案、合规声明。
- 结构建议:目标、范围、流程、标准、执行建议。
- 证据等级:已确认。
证据等级说明
[已确认]:来自官方教程或官方更新说明。[截图直接证据]:来自已确认截图文本或 OCR 原文。[多来源交叉归纳]:跨多个资料源的总结结论。[社区推测]:社区观察或经验总结,须标注为推断。[待验证]:证据不充分、OCR 不清、需要进一步实验验证。
文档状态建议
草稿:仅有初步结构,待补充详细内容。已整理:具有清晰主题和基础内容,可供查询。深度整理:具备完整逻辑、结构、关联和注释。持续扩展中:页面骨架已建,仍有内容持续补充。近完整:主体内容已完成,仅剩边角细节。
编辑提示
- 页面内容尽量精简,避免无意义重复。
- 代码块、表格、提示框应统一样式。
- 所有术语应尽量与
docs/元信息/创游世界术语表.md保持一致。 - 新增页面时,优先补齐
关联文档与适合查询,提高后续检索价值。
