交付文档总览
本板块汇集编写 风云四号02批气象卫星工程C星地面系统 MCS信息安全传输控制软件(项目编号:IIE-MCS-ISTCS)五份交付 Word 文档所需的全部内容。每一页对应一份(或一类)交付文档,按其章节结构组织,可直接据此补全正式 Word 文档。
项目基本信息
| 项 | 内容 |
|---|---|
| 项目名称 | 风云四号02批气象卫星工程C星地面系统 MCS信息安全传输控制软件 |
| 项目编号 | IIE-MCS-ISTCS |
| 委托方 | 北京华云星地通科技有限公司 |
| 研制方 | 中国科学院信息工程研究所 第二研究室 |
| 最终用户 | 国家卫星气象中心 |
五份交付文档清单
| 序号 | 文档 | 文件编号 | 对应素材页 | 当前状态 |
|---|---|---|---|---|
| 1 | 用户手册 | IIE-MCS-ISTCS-UM | 用户手册 | Word 为模板骨架,本站已按 QXJ 重写全部章节,并修正文件编号 |
| 2 | 部署文档 | IIE-MCS-ISTCS-DEP | 部署文档 | Word 为 11 章占位符骨架,本站已填实全部命令与配置样例,并修正文件编号、对齐 Redis 真实键空间 |
| 3 | 软件验收工作与技术总结 | IIE-MCS-ISTCS-SDSR | 验收技术总结 | Word 已有 v3 主体内容,本站做了结构化提炼;原文 5 处留空章节已由编者补写并显式标注 |
| 4 | (技术总结附录)接口设计详录 | — | 接口设计详录 | 从技术总结 v3 接口章节整理;JSBridge 与内部 REST API 已按现网源码重写,旧码表已加对照警示 |
| 5 | 测试报告 / 测试执行记录 | IIE-MCS-ISTCS-TR | 测试材料 | 参照北科融智样例格式,按 QXJ 功能编写 42 个功能用例 + 3 个性能用例,并补充自动化与兼容性测试材料 |
三大业务场景(写作背景)
- 移动设备观测需求信息传输:Pad 端(鸿蒙 NEXT 安全浏览器)经互联网访问 MCS,需双向身份认证与传输加密。
- 主站与灾备站间传输:北京主站与乌兰察布灾备站之间传输任务时间表、调度令、公共配置参数,全程加密与完整性保护。
- 数据外部流转溯源:L0 数据篡改检测与图像水印版权保护,支撑数据外发后的溯源取证。
各文档章节速查
用户手册(三大章)
- 一、初始安装和配置(1.1 初始安装 / 1.2 初始配置:服务器 IP 配置 + 软件配置)
- 二、系统操作(2.1 开关机流程 / 2.2 系统启动 / 2.3 系统停止 / 2.4 使用指南)
- 三、系统运维(3.1 设备硬件检查 / 3.2 系统状态查看 / 3.3 常见故障排查 / 3.4 日常维护保养 / 3.5 日常软硬件巡检)
→ 全部内容见 用户手册
部署文档(十一章)
文档概述 → 部署架构与环境准备 → 后台 Python 服务部署 → 前台页面部署 → Nginx 反向代理 → 进程守护 → 日志监控 → 部署验证 → 回滚与更新 → FAQ → 附录(环境变量 / Nginx / Supervisor / Systemd / Checklist)
→ 全部内容见 部署文档
软件验收工作与技术总结
概述(项目概况、研制要求)→ 技术方案(总体结构、模块设计、处理流程与协议、接口设计、数据库设计、界面设计、关键技术、指标完成情况)→ 研究成果 → 组织管理 → 出错处理 → 安全保密设计 → 维护设计
测试报告与测试执行记录
- 测试报告:封面 / 声明 / 基本信息表 / 测试结论 / 简介 / 测试标准 / 测试环境 / 测试进度 / 测试结果(功能性 + 性能效率)
- 测试执行记录:每个用例一张表(版本、测试项、用例标识、测试数据、步骤、期望与实际结果、通过准则、过程记录、结论)
→ 按 QXJ 功能编写的全套用例见 测试材料
写作约定
- 密级:公开;文档版本自 V1.0 起。
- 用例标识建议格式:
GN_QXJ<年份><顺序号>_YL_<模块>(沿用北科融智样例的编号风格)。 - 测试依据标准:GB/T 25000.51-2016《系统与软件工程 系统与软件质量要求和评价(SQuaRE)第51部分》。
- 所有命令、配置、接口路径以本站对应素材页为准;正式 Word 中的截图位("图 N")需在系统实际环境中截取后补入。
编写工作流:本站素材 → 正式 Word
建议按以下七步将本站素材落成正式交付 Word,保证五份文档口径一致。
第一步:确定文档骨架与封面信息。 按对应素材页的章节顺序在 Word 中建立标题层级(建议"标题 1/2/3"样式,便于自动生成目录);封面统一填写:项目名称、项目编号 IIE-MCS-ISTCS、文件编号(UM/DEP/SDSR/TR)、密级(公开)、版本(V1.0)、编制单位(中国科学院信息工程研究所)与日期。
第二步:誊录正文。 本站页面内容可直接复制:正文用宋体小四、1.5 倍行距;表格复制后统一为五号字、表头加粗居中;代码/命令块改用 Consolas 或 Courier New 小五、灰底,并删除 Markdown 标记符号(#、*、> 等)。
第三步:补图。 各素材页中涉及界面但无图的位置,在实际部署环境中按"图 N-M"(章号-序号)截取,例如:设备注册三步骤、四步握手/登录页、系统首页、设备/用户/角色管理、区域地图、时间规则、日志页、水印工具。图下居中图题,正文先引用后出现。
第四步:统一编号。 逐份核对三类编号:① 文件编号(封面、页眉、版本记录一致);② 用例标识 GN_QXJ20260801_YL_<模块><顺序号>;③ 接口/图表编号(表 2-1、图 3-2 按章编号,正文引用与实际编号一一对应)。
第五步:填写前置与收尾表格。 包括文档修订记录表(版本、作者、日期、修改说明)、测试报告基本信息表(委托/研制/测试单位、起止时间、地点、环境)、测试执行记录每用例一张表。
第六步:口径终检。 重点核对易变事实:接口前缀 /api/v3/、后端端口(生产经 Nginx 443 → 127.0.0.1:8000;联调 4607)、Redis 键前缀 qxj:1:、包名 cn.ac.nsp.qxj.nsp_browser、分发站 https://apps.nsp.ac.cn/。凡 Word 与本站素材不一致处以源码核对后的本站素材为准。
第七步:评审与归档。 项目负责人按质量控制流程组织评审(见技术总结 4.2),留存评审记录;定稿后导出 PDF 与 Word 双格式归档,纸质版按甲方要求份数装订。
本站素材完成状态
| 素材页 | 完成度 | 最近一轮完善内容 |
|---|---|---|
| 用户手册 | 100% | 修正文件编号为 IIE-MCS-ISTCS-UM;补充延伸资料导航与使用流程交叉引用 |
| 部署文档 | 100% | 修正文件编号为 IIE-MCS-ISTCS-DEP;补业务系统并设与 Redis 共享要求、Redis 真实键空间约定 |
| 验收技术总结 | 100% | 补写原文留空的 3.1/3.2/3.3/4.1 及第五章,全部标注"编者补充" |
| 接口设计详录 | 100% | 第三章旧码表加警示并指向现 SDK 码表;补现网资料交叉引用 |
| 测试材料 | 100% | 新增补充测试类型章:自动化接口测试、兼容性测试 |
延伸技术素材(深化与答辩用)
以下页面不属于五份交付 Word 的固定章节,但内容均经源码核实,可在文档深化、现场答疑与面试答辩时直接引用:
| 主题 | 页面 | 可支撑的交付内容 |
|---|---|---|
| HTTP 接口全集 | REST API 参考 | 部署验证 curl 脚本、接口附录、接口数量与路径核对 |
| 网页侧对接 | 前端 JS SDK | MCS 前端如何完成加密登录与加密帧调用 |
| 业务后端对接 | 后端 Python SDK | 技术总结中 verify_token / sm4_gcm_* 的真实签名与码表 |
| 第三方接入 | 业务系统接入指南 | 接入边界、业务后端必须共享 Redis 的联调要求、验收清单 |
| 密码算法 | 传输加密机制 | SM2 协商、SM4-GCM 与 64B 信封的设计说明 |
| 访问控制 | 访问控制策略 | 角色/围栏/时间规则三维策略的功能佐证 |
| 代码资产 | 仓库总览 | 交付物清单与各仓库职责说明 |