软工实践·详细设计·文档书写

软件开发文档书写标准详解及实践 软件设计的核心之一是将大型复杂系统划分为更小、更易于管理的模块。模块化有助于降低复杂性,提高可维护性,并允许并行开发。模块划分时需要考虑以下因素:内聚性:模块内部的元素应该紧密相关,高度内聚。耦合度:模块间的依赖应该最小化。职责分配:每个模块应该有清晰定义的职责,避免职责的重叠。例如,一个典型的三层架构(表示层、业务逻辑层、数据访问层)就需要在设计中清晰地划分每一层的职责。 阅读详情
VersionDateTime
demo5/16/201914:14 AM

详细设计文档包括以下内容:

  1. 功能描述
  2. 输入输出
  3. 算法逻辑
  4. 时序图
  5. 界面原型

功能描述

按照输入、处理、输出的顺序描述一个功能

输入输出

输入

在下方的表格中填写相应数据:

名称标识数据类型数据值的有效范围输入方式其他属性
密码passwordString……用户指定……
………………………………

PW:我觉得“范围”里应该指出字符串长度的最小与最大值。

输出

指出不同情况下的输出内容,比如:

情况输出内容
注册成功邮箱注册成功!
注册失败邮箱注册失败,请稍后再试!(并指出为什么失败以及如何成功)

算法逻辑

逻辑部分提供该功能的逻辑图,使用基础流程图即可。

时序图

文章推介:UML时序图(Sequence Diagram)学习笔记

界面原型

暂时使用xls模拟。以后寻找相关工具。

参考:

  1. UI、UE和UX三者的区别

THANK YOU FOR READING|Author:LonelyObserver (PearlyWave in Github and StackOverflow)

HAVE A GOOD DAY

软件开发文档模板之详细设计 立即下载

相关推荐

系统详细设计文档.docx

系统详细设计文档 Xxx系统 详细设计说明书 Xxx系统 1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑,包括程序描述、输入/输出、算法和流程逻辑等,为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语,为读者在阅读文档时提供必要的参考信息。 序号 术语或缩略语 说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。

详细设计文档模板

原文地址:https://www.cnblogs.com/hellowzl/p/11511922.html 详细设计文档模板 文件名称 文件版本 V1.0 文档编号 总页数 共 页 ...

积累点滴,保持自我 9066

Flask项目详情

Flask诞生于2010年,是Armin ronacher(人名)用 Python 语言基于 Werkzeug 工具箱编写的轻量级Web开发框架。 Flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展Flask-Mail,用户认证Flask-Login,数据库Flask-SQLAlchemy),都需要用第三方的扩展来实现。比如可以用 Flask 扩展加入ORM、窗体验证工具,文件上传、身份验证等。Flask 没有默认使用的数据库,你可以选择 MySQL,也可以用 NoSQL。 其 WSGI 工具箱采用 Werkzeug(路由模块),模板引擎则使用 Jinja2。这两个也是 Flask 框架的核心。

详细设计文档模版

概要性的描述整体技术方案,对技术方案的大体思路有个大致的轮廓,后续再逐项展开。

青鱼入云的博客 2492

如何写软件设计文档.doc

设计文档 - 也被称作技术规范 - 描述了你计划如何去解决一个问题。已经有很多文章解释了编码之前编写设计文档的重要性

02-Cesium-实现天地图标记

首先天地图申请token,然后Cesium-实现天地图标记详细说明

m0_62785037的博客 1171

软件工程——文档篇

可行性研究报告 第一步:引言(编写目的、背景、定义、参考资料) 第二步:项目概述(工作内容、条件与限制、产品、运行环境、服务、验收标准) 第三步:实施计划(任务分解、进度、预算、关键问题) 第四步:人员组织及分工 第五步:交付期限 第六步:专题计划要点 ...

一起加油吧~ 1264

Emscripten安装(wasm编译)

5:配置对应环境变量--替换成自己对应的安装路径(2025最新的Emscripten工具链默认使用LLVM/WebAssembly标准工作流,java依赖已经移除了,所以以下java环境不配,需要使用java的手动添加即可---->emsdk install java-8-152-64bit。3:下载相应的依赖库---->emsdk install latest(我这里下的是最新的,如果有指定版本,把latest替换成版本号即可)6:测试是否成功---> emcc- v/em++ -v。

qq_31578301的博客 556

概要设计要求

1 引言 1.1编写目的   说明编写这份概要设计说明书的目的,指出预期的读者。1.2背景  说明:  a.待开发软件系统的名称;  b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。1.3定义   列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料   列出有关的参考文件,如:  a.本项目的经核准的计划任务书或合同,上级机关的批文;  b.属于本项

Mark Leung的学习总结 2594

ESP-01S获取网络时间踩坑全记录:AT指令调试、JSON解析乱码、时区处理,一个都不能少

本文详细记录了使用ESP-01S WIFI模块获取网络时间的完整过程,包括AT指令调试、JSON解析乱码处理以及时区转换等关键步骤。通过实战案例和代码示例,帮助开发者避开常见陷阱,实现稳定的网络时间同步功能。

weixin_30460489的博客 295

基于互相关(NCC)模板匹配——find_ncc_model_defocused.hdev

相关性原理:仅在NCC(r,c) = ±1时,模板与图像完全匹配; NCC绝对值越大,表示模板与正在检测部分图像越接近; NCC绝对值越接近于零,表示模板与图像越不一致。 线性光照变化不会影响NCC计算结果。 重要函数一: 创建模板:create_ncc_model( Template : : NumLevels, AngleStart, AngleExtent, AngleStep, Metric : ModelID) 参数列表: Template(in):单通道灰度图像,它的区域可被创建为模板。 Num

m0_51271525的博客 3413

概要设计文档和详细设计文档的关系

详细设计文档包含概要设计文档的全部内容(不是绝对),也就是详细设计文档,其实是在概要设计文档的基础上进一步填充内容而得到的。那为什么还要分概要设计和详细设计文档呢,以房子为例:开发商只开发毛坯房,那么此时整栋楼的设计文档就是概要设计文档。然后房子交到不同住户手上,不用的住户在已有的毛坯房的基础上进行装修设计,此时每一个住户都出一份房屋的装修设计文档,这些文档就是详细设计文档。把整栋楼的所有用户的详...

u011447928的专栏 1万+

restbed编译笔记

Restbed 可以构建出基于asio库的restfulAPI服务,Restbed 4.7版本使用了1.12.0版本的asio(其他版本编译不通过),可直接访问github下载:https://github.com/chriskohlhoff/asio/tree/asio-1-12-0。另外Restbed还依赖openssl库(可直接下载exe的安装包,安装后取出lib库及头文件放到到restbed\dependency\openssl中即可,https://slproweb.com/download/W.

mahong100的博客 2106

软工文档总结

软件开发的过程中,文档的编写是一个

Victor 1376

西门子Industrial Copilot实战:5个工业场景下的AI效率提升案例

本文通过五个工业场景实战案例,深入解析西门子Industrial Copilot如何将工业智能转化为实际生产力。从自动化配置、预测性维护到能源优化与人机交互,这位AI助手显著缩短工程周期、提升设备可用率并降低运营成本,展示了其在工业领域系统化、工程化的落地价值。

3c4x5z6v7b的博客 929

C++大牛的博客

1. C++大牛的博客     Bjarne Stroustrup的博客: Bjarne Stroustrup’s Homepage Bjarne Stroustrup,不认识的可以去面壁了,没有他,就没有我们现在的饭碗。Bjarne Stroustrup是丹麦人,目前任教于TAMU。他的Homepage和他的书籍The C++ Programming Language一样

程序猿老樊的博客 6248

软工实践总结

一、请回望暑假时的第一次作业,你对于软件工程课程的想象 1)对比开篇博客你对课程目标和期待,“希望通过实践锻炼,增强计算机专业的能力和就业竞争力”,对比目前的所学所练所得,在哪些方面达到了你的期待和目标,哪些方面还存在哪些不足,为什么? 在当时,我写下的对待这门课的期待是“与一群队友共同学习共同进步,共同作出软件作品,因为‘合作’是目前我的大学前两年中存在感比较低的词汇”。 可以说,我找到了一群非...

weixin_30667301的博客 335

32位快速加法器设计

32位快速加法器设计

好好学习,天天向上 3290

技术文档书写规范

闲来看到一篇很实用的博客,主要是关于书写技术说明文档的正确思路框架,与君共享: 转载:https://blog.youkuaiyun.com/w605283073/article/details/91609253 写文档是程序猿进阶的一个必要步骤之一。 文档写的清楚,思路就更加清晰,也会让同事高看你一眼,多梳理业务也有很大帮助。 产品经理对需求文档基本是驾轻就熟信手拈来,但是大多数程序猿写技术文档却...

LinuxTaoist的博客 1137

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

软工各个文档作用

  一,可行性研究报告 编写时间段:在研发项目之前 主要内容:分析主要的方法,对本项目的实施的可能性,有效性技术方案及技术政策进行具体,深入,细致的技术论证和经济评价。 作用:分析项目是否具有开发的必要性和可行性,并确定最佳方案 阅读的人员:系统管理人员开发与运维人员 二,项目开发计划书 主要内容:参加人员已经各种资料的需求,制定项目开发进度验收标准和成本概算等,,以文本的形式记载下...

weixin_42485453的博客 476

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

软工实践 - 第三十次作业 Beta答辩总结

福大软工 · 第十二次作业 - Beta答辩总结 组长本次博客作业链接 项目宣传视频链接 本组成员 1 . 队长:白晨曦 031602101 2 . 队员:蔡子阳 031602102 3 . 队员:陈德斌 031602104 4 . 队员:乐忠豪 031602121 5 . 队员:李 麒 031602123 6 . 队员:林志华 031602128 7 . 队员:何裕捷 0316022...

dongf952704的博客 281

精雕软件(JDpaint) 5.5 绿色版

精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版精雕软件(JDpaint) 5.5 绿色版

我的软工之路——2011至2012全年总结

好吧,我承认:我已经大四了。走在校园里头,早已看不见那些帅气的师哥、漂亮的师姐了。于我的学生路来说,已经快走到尽头了;然而于我的学习之路,路途依然遥远而艰辛。     走过的一年,是知识、思想大丰收的一年。这一年,让我更加坚定了学下去信念。下面具体分为理想信念进一步坚定、学习进度大概过程、“不将究”的IT意识(思想的进步)和总结四部分对全年所学做一个小小的总结。 理想信念进一步

实鼠不疫,牛转乾坤 4308

xml文档书写

<?xml version ="1.0" encoding="utf-8" ?> <!--xml文档的标准开头,说明这个是xml文档,使用版本是1.0,在这个文档中可以使用中文--> <!-- ①xml语法: 1 html是从xml演化出来的一个编程语言,xml和html是父子关系,html只不过在xml的基础上 事先规定了哪些标签哪些标签不可用,而xml是标签可以任意写,所以被所有浏览器拒绝,因 为解析起来很麻烦,大

weixin_43027596的博客 532
上一篇: 操作系统实验·第一节·学习与实践
下一篇: MiniNote|初识GitHub
PearlyWave
博客等级 码龄8年 8粉丝 40原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值