切换主题
版本与内容维护约定
内容所有权
面向读者的发布指南在 portals/docs-center/web 维护。产品目录名称来自官网数据;工程设计、ADR 与实施记录保留在原模块中。改写为发布指南后,避免两份相同操作文章分别维护。
必填元数据
每篇文章填写标题、摘要、适用人员、适用版本、核验日期、责任模块、实现状态与内容来源。核验日期代表内容核对日期;涉及上线环境时应另行写明验证环境与证据。
文章顶部显示关键阅读信息;仓库来源路径用于维护检查,不要求业务用户理解工程目录。
功能交付时同步更新
- 核对当前菜单、按钮、权限与最终业务结果。
- 更新操作文章和相关 FAQ,补充正常与失败路径。
- 截图来自对应实现,用脱敏或示例数据,并标明示例环境。
- 接口与事件变更同步更新 Schema、路径索引与集成说明。
- 执行内容、链接和构建检查后独立发布。
版本策略
一期展示当前实现。出现不兼容变化时,按应用归档历史版本并提供迁移指南;不要求所有产品同一时间升级或共用版本号。旧链接调整时提供明确重定向。
实现状态
“已实现”表示仓库已有对应能力;“部分实现”需写明当前能力和缺口;“工程骨架”不发布虚构的操作步骤。上线结果由目标环境验收确认。
内容质量
发布操作指南应包含前置条件、操作、结果与常见问题。真实凭据和客户数据不进入公开文档,规划中的功能不能写成现在可以执行的操作。