版本记录与文档维护
V2.0(2026-11-06)
本次更新
- 按当前真实菜单重新梳理用户手册,覆盖八个一级菜单和全部功能页面。
- 新增五条典型业务场景:管理层看经营、业务人员临时问数、AI 生成并调整多图表看板、固定经营报表分发、从 ERP 到经营看板。
- 为 44 个业务与管理功能页补充客户应用演示,统一采用“第一步、第二步、第三步……”编号步骤,并说明最终结果与页面效果。
- 重新采集并脱敏 46 张当前界面截图,配套 8 张业务示意图,做到图文并茂。
- 新增“最终结果与效果”“操作提示”“常见问题”,帮助客户判断操作是否成功。
- 明确区分“功能入口已实现”和“当前演示环境已启用”;涉及外部集成的页面按实际状态说明。
- 业务用户内容优先,开发与运维内容单独成章,避免把接口细节混入日常操作。
内容口径
- AI 对话分析在同一看板中最多生成 5 张图表;方案约 30 分钟有效且一次性消费。
- AI 仅做只读分析,生成前需人工确认,不自动发布看板,也不修改 ERP 业务数据。
- 数据接入使用只读账号、字段校验、行数限制和审计;AI 输出不能替代业务复核。
- 宏澜家电智造集团及其全部业务数据均为演示用的模拟企业和模拟数据。
V1.0(2026-11-05)
覆盖范围
- 八个一级菜单、五个业务中心和统一支撑区。
- 45 个唯一路由功能页,配套 46 张脱敏页面截图。
- 数据大屏、数据探索、智能报表、业务建模、数据治理、系统管理、系统监控、关于与个人中心。
- 开发与运维:架构、运行环境、API、鉴权、权限、AI 编排、测试、发布和回滚。
- 业务快速入门、开发快速入门、常见问题、版本记录和反馈模板。
质量检查
- 页面元数据 ID 唯一,章节顺序与当前菜单一致。
- 截图来自当前运行系统,已脱敏账号、联系方式、会话、内部地址和敏感配置。
- 静态站支持全局搜索、关键词高亮、业务/开发筛选、上一篇/下一篇、图片放大和移动端适配。
- Markdown、静态站、DOCX、PDF 与 BookStack 导入包使用同一份内容源。
- 公开包不包含原始截图、采集清单、采集脚本或环境凭据。
已知环境状态
帮助文档准确区分“入口已实现”和“当前演示环境已启用”。部分数据治理集成在演示环境中显示 DISABLED、连接关闭或未授权;这不表示页面不存在,也不表示生产环境已经完成验收。使用前应由管理员按部署章节核对配置。
文档维护责任
| 角色 | 责任 |
|---|---|
| 产品负责人 | 确认功能范围、术语、版本和发布节奏 |
| 业务负责人 | 审核业务流程、示例、指标口径和角色说明 |
| 开发负责人 | 审核接口、权限、架构、错误码和技术限制 |
| 测试负责人 | 验证复现步骤、截图状态和功能可用性 |
| 运维负责人 | 审核部署、监控、备份、安全和故障处置 |
| 文档维护人 | 合并修订、生成发布包、执行链接和敏感信息检查 |
文档变更流程
- 需求或缺陷确认后,记录变更单号、影响页面和责任人。
- 更新唯一内容源中的 Markdown,不只改导出的 DOCX/PDF。
- 在测试环境重新操作受影响页面,必要时更新脱敏截图。
- 由业务或开发审核人确认内容与实际行为一致。
- 重新构建静态站,生成 DOCX、PDF 和 BookStack 导入包。
- 执行链接、搜索、图片、响应式、导出和敏感信息扫描。
- 记录版本号、日期、变更摘要、审核人与发布地址。
- 发布后抽查线上目录、搜索、图片和移动端页面。
反馈闭环
请通过帮助中心右上角“文档反馈”复制反馈模板,或使用企业支持渠道提交。建议反馈包含:
文档页面:
产品版本:
问题类型:内容错误 / 操作失败 / 图文不一致 / 缺少说明 / 其他
发生时间:
复现步骤:
期望结果:
实际结果:
影响范围:
可公开的截图或请求 ID:
不要在反馈中提交密码、API Key、Token、Cookie、数据库口令、客户明细或未脱敏截图。
发布验收记录
每次发布至少确认:
- 首页、目录、搜索、筛选、上一篇/下一篇和反馈入口可用。
- 图片点击放大,图示和页面截图均能加载。
- 桌面与手机宽度无横向溢出。
- DOCX 与 PDF 可打开,标题、表格和图片未丢失。
- 公开包敏感信息扫描通过。
- BookStack 发布凭据存在时,执行同名检查和发布后验证;凭据缺失时明确标记为未发布。