2.9 KiB
2.9 KiB
实现方案:软著说明书图文化与代码汇总扩容
实现方案文档路径:工程分析/实现方案-2026-05-20-11-34-57.md
修改目标
将软著说明书从初稿扩展为更完整的图文说明书,插入当前系统真实截图;将代码汇总 Markdown 扩展至至少 1600 行,同时保留软著材料不进入 Gitea 的约束。
涉及路径
新撰写软著文档/1. 软著说明书.md新撰写软著文档/1. 软著说明书.docx新撰写软著文档/3. 代码汇总.md新撰写软著文档/3. 代码汇总.docx新撰写软著文档/images/新撰写软著文档/功能验证与素材清单.md工程分析/需求分析-2026-05-20-11-34-57.md工程分析/实现方案-2026-05-20-11-34-57.md工程分析/测试方案-2026-05-20-11-34-57.md工程分析/经验记录.md
技术路线
- 阅读
※撰写Agent.md和现有软著初稿,确认说明书、截图、Word、代码汇总要求。 - 使用当前部署服务打开系统页面,通过自动化截图生成登录页、概况页、项目库、DICOM 查看、逆向工作区、系统管理等图片。
- 重写并扩展软著说明书 Markdown,将图片以
形式插入对应章节。 - 从
WebSite/src和WebSite/server.ts中抽取核心代码,生成至少 1600 行的3. 代码汇总.md。 - 使用
python-docx生成或覆盖说明书和代码汇总 Word,保证图片嵌入、代码文本可编辑。 - 使用
unzip -t、wc -l、图片引用检查验证交付物。 - 本次仅将工程分析文档与经验记录提交 Gitea,不提交
新撰写软著文档/。
执行步骤
- 检查本地服务与截图工具可用性。
- 生成截图到
新撰写软著文档/images/。 - 扩写
1. 软著说明书.md。 - 扩充
3. 代码汇总.md至不少于 1600 行。 - 重新生成
1. 软著说明书.docx和3. 代码汇总.docx。 - 更新素材清单。
- 运行文档检查和必要的项目构建/健康检查。
- 精确暂存本次工程分析文档和经验记录,提交并推送。
兼容性与回滚方案
- 软著材料位于本地输出目录,不影响应用运行。
- 若自动化截图失败,可保留已有文档并记录失败原因;但目标仍是完成真实截图插入。
- 若 Word 生成失败,保留 Markdown 和图片作为可恢复源文件。
预计文件变更
本地软著材料:
- 更新说明书 Markdown/Word。
- 更新代码汇总 Markdown/Word。
- 新增截图图片。
- 更新素材清单。
版本库备份:
- 新增本次工程分析三份文档。
- 追加
工程分析/经验记录.md。
提交与部署策略
- 不暂存
新撰写软著文档/。 - 不暂存
参考软著构建模板/、※撰写Agent.md、head-ct-demo-pose-data.json。 - commit message 包含
2026-05-20-11-34-57和简要描述。 - 推送 Gitea 后执行或确认当前服务部署健康。