文档在项目开发中的作用

2024-05-19 19:39:29

在开发团队中做了一段时间的文档工作，现在总结一下我对文档的理解。
希望可以帮助到对文档工作感兴趣的小伙伴，
也非常渴望各位大佬的宝贵指点！

我在刚刚做文档工作的时候，也是一脸懵。不知道这份工作具体是什么样子的，现在发现文档在开发过程中有以下作用：

提高沟通效率，降低沟通成本
规范、连接各个开发环节
数据留存

提高沟通效率，降低沟通成本

在团队合作中，是需要每个团队成员的之间配合的，那就团队成员之间就一定会有大量的沟通。
如果两个人口头传递信息，要求表达者要清晰明了的表达出全面、准确的大量信息，要求听着要一直跟着表达着的节凑，这样的一次沟通会花费两个人的大量时间，而且不一定会有一个很好的沟通结果。
如果将表达者想要传递的信息写到文档上，这样会节省两个人的沟通时间，提高工作效率

规范、连接各个开发环节

不同的开发环节都有一个规范的工作文档，那么整个团队的工作也会更加规范、更加有条理性。
比如：

在设计过程中，
- 规范的设计文档可以让设计工作更加有有条理性。
- 规范的设计文档可以让前端开发人员更快速、更详细的了解设计效果
在代码开发过程中，良好的代码规范是必不可少的
在测试过程中，
- 规范的测试文档可以让测试工作更加有条理性
- 规范的测试文档可以让测试人员更快速、更准确的将问题反馈给开发人员

数据留存

我也会做各种会议记录，并整理成会议纪要。比如“工作例会”、“设计评审会议”等等……
这要求我要在会议过程中一直高度集中注意力，并且快速将大家的对话转为文字信息记录下来，（如果会议时间很长的话，就有一种快要窒息的赶脚。。。），那么整理完成的会议纪要很可能就是接下来整个开发团队的工作安排。
在做复盘的时候，文档是很重要的参考哦~

文档在项目开发中的作用相关推荐

Spring 2.5 jar 所有开发包及完整文档及项目开发实例
Spring 2.5 jar 所有开发包及完整文档及项目开发实例 spring jar 包详解spring.jar是包含有完整发布的单个jar包,spring.jar中包含除了 spring-mock ...
项目开发中发布更新文档备注
项目开发中经常会遇到某一个团队成员更新了,配置文件但是没有及时沟通导致项目发布后出现异常的情况. 这时就需要一个项目更新发布的规范说明文件,比如每次更新更改了哪些,进行文档备注. 更新的脚本文件也 ...
反思：项目开发中的语言沟通与文档沟通
反思:项目开发中的语言沟通与文档沟通问题引出:刚进入公司试用期,有导师安排开发实现一些功能模块或者小的应用.毕竟需要在整个产品的框架下添加代码,看了下整个产品近1G的源代码,相当浩瀚.虽然是不需要我 ...
浅谈软件开发工具CASE在软件项目开发中发挥的作用认识
浅谈软件开发工具CASE在软件项目开发中发挥的作用认识内容摘要:阐述了CASE工具作为一种开发环境在软件项目开发中所起到的开发及管理作用.CASE工具实际上是把原先由手工完成的开发过程转变为以自动 ...
【开发规范】go项目开发中的[流程,git,代码,目录,微服务仓库管理,静态检查]
文章目录前言一.有哪些规范我们应该遵循二.项目开发流程三.git的代码分支管理 1. 分支管理 2. commit规范三.go的代码规范四.go项目目录规范五.微服务该采用multi-r ...
【转】缺陷与出路—一个游戏开发者的反思二、项目开发中的混沌和秩序
二.项目开发中的混沌和秩序我们可能都听说过这些说法:"你不可能不劳而获""覆水难收"或"天网恢恢,疏而不漏".如果这些谚语对你说来不算陌生 ...
甲方在项目开发过程中的作用
[摘要]软件项目的开发是一个综合性的工程,需要项目相关各方努力配合.随着信息化程度的深入,软件项目的复杂度和精细化程度越来越高,对项目相关方的配合也提出了更高的要求.项目开发不仅仅是软件开发公司的工作 ...
React项目开发中的数据管理
原文链接:https://blog.csdn.net/hl582567508/article/details/76982756 redux中文文档:http://cn.redux.js.org/ Re ...
项目开发中的自我总结
最近忙的要死,因为新开发了两个项目.现在已经测试完毕了,准备部署到线上了. 然后不能白忙活吧,忙活完也得写点总结和经验吧,以后也有个记录. 1.一个bootstrap+jquery+layui+lar ...

最新文章

热门文章