
先确认要找哪一种设计文档
“设计文档”可能指课程项目的需求说明、系统架构、接口设计,也可能指区块链底层协议的开发资料。前者描述某个实训作品打算如何实现,后者解释区块链平台本身的机制;两者不能互相替代。若报告要求介绍本组项目,应优先寻找与该项目直接对应的文件。
从课程材料和项目文件开始检索
先查课程平台、教师发布的任务说明、实验指导书和课堂共享目录,再查看项目代码仓库中的 README、docs、设计说明、接口说明或架构图。可组合使用课程名称、实验编号、项目名称与“需求”“架构”“接口”“部署”等词检索。若找到的文件没有版本信息、作者或与代码的对应关系,应标注为待核实,不要直接当作最终设计依据。

如果仓库里只有代码而没有单独的设计文档,可依据实际目录结构、配置文件和接口定义整理实现说明,并明确区分“代码中可观察到的内容”和“设计者原先的意图”。不要把推测写成项目已确认的功能。

用技术文档补足区块链基础
以太坊开发者文档的入门内容介绍了区块链、节点、共识、交易、EVM 与智能合约等概念。其说明指出,区块通过对前一区块的密码学引用连接起来;网络节点保存并传播状态,交易经验证和执行后会带来状态变化。写实训报告时,这些概念可用于解释系统架构和数据流,但不能据此断言某个课程项目采用了相同实现。
Bitcoin Developer Guides 的目录列出区块链、交易、合约、钱包、支付处理、运行模式、P2P 网络、挖矿及 RPC API 等主题。可按项目实际涉及的模块挑选对应主题作为背景资料;目录本身只说明资料的组织范围,并不能证明你的项目具备其中某项功能。
把查到的资料映射到报告结构
通常可以按“项目目标与适用范围—需求—整体架构—模块职责—数据与交易流程—接口—测试与局限”组织设计部分。涉及智能合约时,说明合约代码承担什么逻辑、调用参数如何影响状态;涉及节点或网络时,说明节点之间需要交换什么信息。每一项都应尽量对应到项目文件、实验结果或教师要求。
引用技术资料时,记录页面名称、发布方和访问日期,并在文中指出它支撑的是哪条概念说明。项目自己的设计文件则尽可能记录文件名、版本或仓库位置。若未能核实某个实现细节,应直接写明资料不足,而不是补造流程、性能数据或结论。
常见问题与适用条件
找不到名为“设计文档”的文件怎么办?先检查实验任务和代码仓库是否把内容放在 README、说明目录或接口文档中;仍没有时,可根据可核验的代码与实验记录整理说明,并标明整理依据。
官方技术文档能否直接作为项目设计文档?不能。它适合解释通用协议或平台概念,不能替代本项目的需求、架构和实现证据。报告应以课程要求和实际项目材料为主,以通用开发文档补充背景。