V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
bbmike253455
V2EX  ›  程序员

本人学生,参加一个 xxx 比赛,写了简单的 web 应用,要求写设计文档,请问以下文档模板是正经的么 [狗头]

  •  
  •   bbmike253455 · 2020-12-08 20:53:44 +08:00 · 1920 次点击
    这是一个创建于 1206 天前的主题,其中的信息可能已经有所发展或是发生改变。

    XXX 比赛--详细设计

    程序 1 (标识符)设计说明

    从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。

    程序描述

    给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如是常驻内存还是非常驻?是否子程序?是可重入的还是不可重入的?有无覆盖要求?是顺序处理还是并发处理?.....等)。

    功能

    说明该程序应具有的功能,可采用 IPO 图(即输入-处理-输出图)的形式。

    性能

    说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。

    输入项

    给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

    输出项

    给出对每一个输出项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。

    算法

    详细说明本程序所选用的算法,具体的计算公式和计算步骤。

    流程逻辑

    接口

    用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。

    存储分配

    根据需要,说明本程序的存储分配。

    注释设计

    说明准备在本程序中安排的注释,如:

    • 加在模块首部的注释;
    • 加在各分枝点处的注释;

    限制条件

    说明本程序运行中所受到的限制条件。

    测试计划

    说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。

    尚未解决的问题

    说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。


    我感觉跟个傻子似的,前后端是我写的,但按照这个模板,我完全无法下手,我怀疑写文档模板的是 [狗头] 还是说这个模板是为特定的软件、算法或者其他东西准备的???

    7 条回复    2020-12-09 09:43:27 +08:00
    creedowl
        1
    creedowl  
       2020-12-08 20:56:05 +08:00 via Android
    这些东西学一下软件工程就知道了
    thetbw
        2
    thetbw  
       2020-12-08 21:29:48 +08:00
    就像写小学写日记一样无趣
    dethan
        3
    dethan  
       2020-12-08 21:53:45 +08:00 via Android
    这是详细设计文档
    youla
        4
    youla  
       2020-12-08 22:22:47 +08:00 via Android
    设计文档:没有,只有拍脑袋拍出的一个个想法!
    HenryWang0723
        5
    HenryWang0723  
       2020-12-08 22:25:17 +08:00
    一般企业都会让你写的,尤其是非互联网 toC 的企业,能占据你大量的工作时间
    saulshao
        6
    saulshao  
       2020-12-09 08:57:53 +08:00
    这种东西就瞎写就行了。胡乱填,如果你的没有,就不填。
    hejw19970413
        7
    hejw19970413  
       2020-12-09 09:43:27 +08:00
    这个要写得要写一周左右。。。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5355 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 34ms · UTC 09:02 · PVG 17:02 · LAX 02:02 · JFK 05:02
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.