文档小结

简介:         昨天师傅终于讲文档了,解开了我很多困惑。          一,文档中的重复现象                   在写文档的时候,很多地方是重复的,当时自己的做法就是把这些重复的地方复制粘贴,也没有去想这些地方为什么重复?这些重复的内容是否都应该写一样的内容?           首先回答为什么重复的问题。

        昨天师傅终于讲文档了,解开了我很多困惑。

         一,文档中的重复现象

                  在写文档的时候,很多地方是重复的,当时自己的做法就是把这些重复的地方复制粘贴,也没有去想这些地方为什么重复?这些重复的内容是否都应该写一样的内容?

          首先回答为什么重复的问题。文档中的重复首先是为了保证文档的完整性,当下一个阶段的人员在读上一个阶段的人员写的文档的时候,可以不用翻看之前所有的文档,只需看这之前的一个文档就行了。对于文档中重复的内容,它们其实在真正的开发过程中是不一样的。在需求很明确的软件开发中,如果采用瀑布模型进行开发,这个开发过程是要层层递进的,也就是说,下一个阶段的进行要基于上一个阶段的文档,不跳回去修改或很少返工。所以,这时候写的文档应该是按照开发流程,逐步细化的过程。比如,概要设计说明书中的输入输出和详细设计中的输入输出区别就是:概要设计说明书中的输入输出可以概括的写一下,而在详细设计中的输入输出则要非常具体,因为详细设计完成之后,就要马上进行编码了。


      二,主要文档中的主要内容

          昨天师傅讲解文档的时候,对我文档中华而不实的地方笑话我好久。因为文档是给人看的,所以要猜测大家喜欢看到什么,怎么写才能更明确,废话更少。所以,在每个文档中,应分清主次。下面列出主要文档中的主要内容:

  

    其实在写文档中,我脑子里面一直有这样一个声音在跟我说:就你写的这个文档,能编出软件来才怪。有这样想法的原因,主要是感觉自己想写的东西没有写出来,也不知道该怎么表达,图画的也不好,主次不清的原因。

  

        经过这次写文档后,感觉自己得到了一个如何写好文档的方向,虽然这个思路还不是很清晰。

目录
相关文章
|
Windows
阿里云的在线文档中,通常不提供直接导出为PDF或其他文档格式的功能
阿里云的在线文档中,通常不提供直接导出为PDF或其他文档格式的功能
661 1
Adoc文档的使用
Adoc文档的使用
80 0
|
移动开发 JavaScript 开发工具
less文档和安装
less文档和安装
161 0
|
API Python
利用flasgger生成FlaskAPI文档
利用flasgger生成FlaskAPI文档
290 0
利用flasgger生成FlaskAPI文档
|
前端开发 JavaScript Apache
LESS文档
LESS文档
367 0
|
XML JavaScript .NET
|
数据安全/隐私保护

相关实验场景

更多