怎样编写软件文档

1、软件开发的步骤:需求理解分析、设计、编码、调试、验收。功能上的关系:可以使用UML中的用例图来体现(需要懂得UML如何画)。数据上的关系:UML中类图、Sequence图都是非常便利的。抽象出类:这个需要知道面向对象的知识。

2、概要设计主要阐述系统的目标、建设原则,系统的功能模块及数据库概要设计(有哪些表名),概要设计面向设计人员和用户,简单说,用户也能看得懂,不要求太细节,是对用户需求的技术响应,是二者沟通的桥梁。

详细设计则是在概要设计的基础上对系统的各个模块进一步细化,分析各个模块的子模块,甚至给出各子模块的算法;数据库设计方面则要求到具体每张表的字段。通常面向开发人员,应该是开发人员看了你的详细设计,就可以直接写代码。
时间: 2024-08-26 17:38:04

怎样编写软件文档的相关文章

《结对-结对编项目作业名称-需求分析》

一.             引言1.   编写目的 本文档将对<贪吃蛇>游戏软件开发需求进行描述,开发出一部属于自己的软件游戏.2.   背景 本项目作为训练编写软件文档而提出,通过了解<贪吃蛇>的游戏开发历程,了解软件文档的相关标准和编写原则,训练并掌握各类文档的写作技巧.本项目也作为实验教材. 本项目的名称:贪吃蛇游戏软件 本项目的提出者:高云鹏,孙晨旭 本项目的开发者:高云鹏,孙晨旭 3.   参考资料 ① 基于控制台实现贪吃蛇游戏 ②python学习笔记05:贪吃蛇游戏代

软件工程建议

在空白的文本编辑器里打开一个崭新的文本,没有一行代码,出现在眼前的是一个充满了无限可能和希望的项目.可是,当数千行的代码写完之后,整个项目因为bug的出现而被压垮了,更别说添加什么新功能了...这也许是对程序员的最大打击,在饱满的热情上浇了一盆冷水.其实,最好的软件程序员当然知道怎样去发现并修复这些bug,在刚开始编程的时候就通过软件工程的最好方法来降低bug的出现概率. 几乎没有哪个程序员能够写出一个bug都没有的代码,但是解决方法总是比困难多得多.多实践和坚毅的决心是成功的关键,这样才能够写

程序员的编程、调试、排错小建议

在空白的文本编辑器里打开一个崭新的文本,没有一行代码,出现在眼前的是一个充满了无限可能和希望的项目.可是,当数千行的代码写完之后,整个项目因为bug的出现而被压垮了,更别说添加什么新功能了...这也许是对程序员的最大打击,在饱满的热情上浇了一盆冷水.其实,最好的软件程序员当然知道怎样去发现并修复这些bug,在刚开始编程的时候就通过软件工程的最好方法来降低bug的出现概率. 几乎没有哪个程序员能够写出一个bug都没有的代码,但是解决方法总是比困难多得多.多实践和坚毅的决心是成功的关键,这样才能够写

程序员最艰巨的任务跟编写代码没有多少关系

去年看到的文章,记在了EverNote中,今天做总结时又看了一下,贴在这里吧. 程序员最艰巨的任务跟编写代码没有多少关系.编码是逻辑思路的一种实践,这跟程序员日常工作中的其它任务比起来相对简单.如果你认为自己还是一个水平一般的程序员,在你真正的能进入到高手行列前,请确保你已经克服了下列晋级的障碍. 1. 解释你在干什么 解释软件开发过程是一个很困难的事情.那些非程序员职业的人也许知道很多关于编程的事情,但很显然,他们不会编程.对于他们来说,我们的生活就是在一间黑暗的屋子里趴在键盘前消耗着咖啡.

利用 Django REST framework 编写 RESTful API

利用 Django REST framework 编写 RESTful API Updateat 2015/12/3: 增加 filter 最近在玩 Django,不得不说 rest_framework 真乃一大神器,可以轻易的甚至自动化的搞定很多事情,比如: 自动生成符合 RESTful 规范的 API 支持 OPTION.HEAD.POST.GET.PATCH.PUT.DELETE 根据 Content-Type 来动态的返回数据类型(如 text.json) 生成 browserable

如何编写一个带命令行参数的Python文件

看到别人执行一个支持命令行参数的python文件,瞬间觉得高大上起来.牛逼起来,那么如何编写一个带命令行参数的python脚本呢?不用紧张,下面将简单易懂地让你学会如何让自己的python脚本,支持命令行参数. 首先你要知道python中的sys模块的一些功能: import sys print "the number of python program's argument:",len(sys.argv) print "the value of every argument

转载---编写高质量代码:改善Java程序的151个建议(第3章:类、对象及方法___建议47~51)

阅读目录 建议47:在equals中使用getClass进行类型判断 建议48:覆写equals方法必须覆写hashCode方法 建议49:推荐覆写toString方法 建议50:使用package-info类为包服务 建议51:不要主动进行垃圾回收 回到顶部 建议47:在equals中使用getClass进行类型判断 本节我们继续讨论覆写equals的问题,这次我们编写一个员工Employee类继承Person类,这很正常,员工也是人嘛,而且在JavaBean中继承也很多见,代码如下: 1 p

如何编写方法

1.编写方法要考虑的内容 (1)通过项目的需求了解方法要完成的具体任务是什么 (2)确定方法的可访问性(private默认) (3)这个方法调用后能够产生的结果是什么 (4)给这个方法起一个"响亮"的名称 (5)调用这个方法需要的条件是什么(参数) 2.方法具体定义规范 访问修饰符 返回值类型  方法名称(各个参数) { ////方法具体要完成的任务 return 返回值: }

sublime text3---Emmet:HTML/CSS代码快速编写神器

Emmet的前身是大名鼎鼎的Zen coding,如果你从事Web前端开发的话,对该插件一定不会陌生.它使用仿CSS选择器的语法来生成代码,大大提高了HTML/CSS代码编写的速度,比如下面的演示:  Zen coding下的编码演示 一.快速编写HTML代码 1.  初始化 HTML文档需要包含一些固定的标签,比如<html>.<head>.<body>等,现在你只需要1秒钟就可以输入这些标签.比如输入"!"或"html:5",