文档小结

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

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

         一,文档中的重复现象

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

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


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

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

  

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

  

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

目录
相关文章
|
机器人 Windows
QQ机器人有哪些?QQ机器人怎么设置?
随着QQ群的活跃,越来越多的群组需要用机器人来管理群,比较流行的QQ机器人有哪些?QQ机器人又需要怎么设置?目前市面上有很多QQ群机器人,其中比较流行的有第十代qq机器人、酷q机器人等。这些机器人都有各自的特点和功能,可以满足不同的需求,具体需要怎么设置机器人呢?下面就拿第十代QQ机器人给大家举例。
|
安全 网络安全 文件存储
思科设备巡检命令Python脚本大集合
【10月更文挑战第18天】
518 1
思科设备巡检命令Python脚本大集合
|
缓存 安全 UED
网站图片缓存设置不当可能会导致哪些问题?
【10月更文挑战第18天】网站图片缓存的合理设置至关重要,需要综合考虑图片的性质、更新频率、用户体验、服务器性能等多方面因素,以避免出现上述各种问题,确保网站的正常运行和用户信息的安全。
|
数据采集 人工智能 自然语言处理
文档智能与检索增强生成结合的LLM知识库方案测评:优势与改进空间
《文档智能 & RAG让AI大模型更懂业务》解决方案通过结合文档智能和检索增强生成(RAG)技术,构建企业级文档知识库。方案详细介绍了文档清洗、向量化、问答召回等步骤,但在向量化算法选择、多模态支持和用户界面上有待改进。部署过程中遇到一些技术问题,建议优化性能和增加实时处理能力。总体而言,方案在金融、法律、医疗等领域具有广泛应用前景。
360 11
|
机器学习/深度学习 传感器 算法
智能机器人在工业自动化中的应用与前景###
本文探讨了智能机器人在工业自动化领域的最新应用,包括其在制造业中的集成、操作灵活性和成本效益等方面的优势。通过分析当前技术趋势和案例研究,预测了智能机器人未来的发展方向及其对工业生产模式的潜在影响。 ###
793 9
|
网络协议 安全 数据挖掘
IPv6与IPv4有何不同
【10月更文挑战第26天】IPv6与IPv4相比,具有更大的地址空间、更小的路由表、增强的组播支持、自动配置支持和更高的安全性。IPv6地址长度为128位,几乎无限的地址资源解决了IPv4地址枯竭的问题;聚类原则减少了路由表大小,加快数据转发速度;自动配置简化了网络管理;加密技术提升了网络安全性。企业迁移到IPv6可以确保未来网络的可持续发展,提高效率和安全性。
1149 0
|
Java 数据库
史上最全的 IDEA Debug 调试技巧(超详细案例)(二)
史上最全的 IDEA Debug 调试技巧(超详细案例)(二)
史上最全的 IDEA Debug 调试技巧(超详细案例)(二)
|
XML JavaScript Java
技术:Java-Web基础|XML解析(四)之JAXP-dom4j
XML是标记型文档,js 使用 dom 解析标记型文档是根据 html 的层级结构,在内存中分配一个属性结构,把 html 的标签,属性和文本都封装成 document 对象、element 对象,属性对象、文本对象,node 节点对象。「XML」解析技术xml的解析技术:dom 和 sax。
技术:Java-Web基础|XML解析(四)之JAXP-dom4j
|
安全
论文免费查重网站推荐
本文介绍一些靠谱、安全、免费的论文查重平台~
2343 1