Zhou Study hard, improve every day.

如何写方案设计

2021-07-21
本文 811 字,阅读全文约需 3 分钟

如何写方案设计

本文总结方案设计的一些要点,方便后续文档书写的规范。

本文参考csdn上一篇博文。位置如下

如何写出一个好的设计文档

1.前言

开发人员(我)比较大的一个问题就是,需求一听就开始写,但是缺少一个确认的过程。

所以今后听到需求,先确认需求–>再确认时间–>最后开始写–>写好后写总结文档

方案设计则比需求的范围大。它涉及到一个项目的最开始(目标),和项目的最终产物(输出、打包运行)。

2.设计文档需要哪些内容

一个好的设计文档需要考虑业内的各种实现方案,不能闭门造车。

我认为主要会分为8个部分。分别为 项目背景,项目目标,需求分析,方案对比,概要设计,详细设计(存储模型设计,接口设计),开发以及上线计划,方案排期。

2.1项目背景

需要首先交代该项目想解决的问题,想完成的目标。比如。

该项目主要是想完成一个商城项目,稳定性好,方便拓展。

然后介绍该商城项目的大体目标,目前预估的使用人数等,方便新进项目人员快速理解项目背景,理解需求。

2.2项目目标

目前不懂

2.3需求分析

简要介绍需求,列出子模块,及子模块的作用。

子模块中具体想实现的功能。

总之分块描述,尽量详细。例如

  • 商城模块

    • 商城主页的分类及部分商品。
    • 订单系统,下单,及物流
    • ……

2.4方案对比

目前该种系统的主流实现方式,优点及缺点对比。

最终选择某种实现方式,并说出理由。

2.5概要设计和详细设计

先画出整体架构图,大致的模块,调用逻辑或时序图。

详细设计则涉及数据库表、接口的设计。

swagger怎么用?有时间学学。

2.6开发以及上线计划

没做过。我理解是确认这个功能需要多少人,多少天完成。

2.7方案排期

开发计划,列出人天。将计划细分出来。

目标就是可以照着该开发计划开始开发。

如果你有好的想法,欢迎交流。


下一篇 log4j使用整理

Comments

Content