软件项目的文档编写方法
来源:互联网 发布:阿里云短信平台充值 编辑:程序博客网 时间:2024/06/10 04:58
做软件开发的人员都知道,需要写项目文档,各种文档想到的想不到的应有尽有,但是对于文档的编写又开始头疼,不知道如何写。下面我来说说,不对的地方大家提意见,别扔鸡蛋哦……嘻嘻……
第一部分,先写一封面,封面上内容包括公司名称,项目标题,作者,写文档日期
第二部分,写修改历史,记录版本号,把每次修改的时间,作者和原因都记录下来,如有必要写添加版权声明,当然不会写可以在网上找找,可以自己修改一下别人写的那些。(这个简单方法……)
第三部分,写文档摘要,记录此文档大约包含哪些内容,如是重要问题需要说明的可以加大篇符来描述。
第四部分,文档目录(这都不用说了吧,一般软件项目的文档都要有一个很长的目录,因为涉及的问题很多)
第五部分,正文,先写标题,标题要空掉一行,不要顶行写,接下来的内容要包括项目背景、项目简介,在项目简介中要包含全文,写明文档的中心思想,要起到引起下文的作用、专业术语的定义、文档主要描述的内容,当然不同的项目文档需要描述的详细内容有所不同,可跟据不同的项目文档标准来规范文档内容。可分成大的标题,例如ABCD几个题标一一例举,在写作过程中有必要的数字,来增加文档的说服力。
第六部分,总结,主要写对ABCD几大标题的总结,再次阐明中心思想。也就是说文档要依照总分总的形式来完成。
第七部分,附件,此文档中需要引用哪些附件写在这里,可以是描述性的文字,也可以是书籍名称,还可以是网址等内容。但是这些内容必须是经过专家认可的。
最后,在文档完成后写要上必要的页眉和页脚。如页眉可以写项目名称文档标题,公司名称,页脚可以写页码等等。总之要排版规范,让人看着感觉舒服。
- 软件项目的文档编写方法
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的标准化文档编写
- 软件项目开发过程中应编写的文档
- 项目文档的编写
- 项目文档的编写
- 软件开发项目-文档编写标准化--总结
- 软件开发项目-文档编写标准化
- 项目评审文档的编写
- 项目评审文档的编写
- 软件开发项目-文档编写标准化--软件需求说明书
- 软件开发项目-文档编写标准化--软件维护手册
- 我的技术博客
- ETL工具——kettle插件开发(基础篇)
- centos5.0 死活不认 sata 郁闷的 上午
- 继承类的调用方法 Animal and Cat
- 输入、输出文件函数
- 软件项目的文档编写方法
- JS将时间写入页面
- a:visited 难题
- IBM 000-032认证题库资讯
- 浅谈服务器集群技术
- c++ 双向链表代码
- 111
- 联合编译器IncrediBuild不支持中文项目路径
- Chronometer 计时器的使用