工作中写文档的一些经验总结

2024-03-25 16:58

本文主要是介绍工作中写文档的一些经验总结,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

工作中写文档的一些经验总结

在工作中,有很多时间是在写设计文档、配置说明、升级部署等文档。

有时候真的很烦写文档,但是写文档又是必不可少的重要工作内容。

如何写好文档?

我个人在工作中有一丢丢的经验总结:

一、尽可能形象化,避免抽象化

以设计文档来说,用一段文字来描述“程序的算法流程”看起来实在太枯燥无味。

应当尽可能使用图表的形式来替代原有的文字的形式。(信息是蕴含在图表、文字中的嘛,<( ̄▽ ̄)/)

善于使用流程图、时序图、UML类图等来替代文字性的描述,用表格、饼图、柱状图等来对数据进行统计总结…

尽可能将想要表达的信息,蕴含在图表中,这样会形象很多,使得接收信息者更好地接收你的“想法”。

拿伪代码描述好吗?

好,当然好,但是是分情况的好。

若注重于细节描述,使用伪代码当然比流程图好;
若注重于流程描述,使用流程图当然比伪代码好;

简单来说,合理地、恰当地使用图表来使自己想要传达的信息具象化,使得自己的文档更“易读易懂”。

二、有轻有重,有主有次

如同写文章,一定要有主有次,有轻重缓急之分。

在写代码时,有个时刻应当考虑重构:

相似度超过一定程度的代码,在多次出现时,应有重构的可能,例如作为一个公共的函数来调用?

千篇一律的代码,一定是有重构的必要性,好的代码是有轻有重,是形态迥异的,如同散文一般。

写文档也应时刻牢记,文档是要表达你的主要意图,合理安排文章的逻辑结构,突出重点、将主要信息置前强调,将次要的信息置后,让读者一目了然,能最快,最准确地把握中心思想。

或在写一段文字描述时,用高亮、加粗、斜体等方式,将重要的信息“突显”出来。

但是应注意,千万别“处处突显”,那样失去了“突显”的本意,你可以在读书时划一两个标记标出重点,但是通篇全是标记,也就看不出重点咯。

三、写的越多越好吗?

文档内容可不是越多越好!

没有重点的一大段内容,简直如同老太太的裹脚布。

很多时候内容越多会起到相反的作用,因为内容太多,读者从你的“海量”内容中获取其目的信息就更加困难。

你要找一个信息点,是从10个信息点集中查找容易呢?还是从100个信息点集中查找容易呢?答案不言而喻。

你以为内容多点,详细点是为读者考虑,但是你恰恰为其增加了信息的获取困难度。

四、从读者的角度出发

通常如何设计API接口?你需要考虑的一点是易读性。

好的API接口应该是与其功能密切相关,使用者看到API就知道接口的功能,设计API的形式是站在使用者的角度。

写文档也类似。

文档的价值在于可读、快速、准确。

读者希望看一遍就能有个大概,那你应该琢磨:如何写,读者能印象深刻呢?例如形象描述一点?少点抽象描述?

读者有时希望快速查阅自己关心的信息,那如何能使读者减少查找时间呢?突出重点、有条有理应该会有点帮助吧?写得多真的有帮助吗?内容少一点,准确一点,突出一点或许更好呢!


未完待续。

这篇关于工作中写文档的一些经验总结的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/845647

相关文章

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

工作常用指令与快捷键

Git提交代码 git fetch  git add .  git commit -m “desc”  git pull  git push Git查看当前分支 git symbolic-ref --short -q HEAD Git创建新的分支并切换 git checkout -b XXXXXXXXXXXXXX git push origin XXXXXXXXXXXXXX

嵌入式方向的毕业生,找工作很迷茫

一个应届硕士生的问题: 虽然我明白想成为技术大牛需要日积月累的磨练,但我总感觉自己学习方法或者哪些方面有问题,时间一天天过去,自己也每天不停学习,但总感觉自己没有想象中那样进步,总感觉找不到一个很清晰的学习规划……眼看 9 月份就要参加秋招了,我想毕业了去大城市磨练几年,涨涨见识,拓开眼界多学点东西。但是感觉自己的实力还是很不够,内心慌得不行,总怕浪费了这人生唯一的校招机会,当然我也明白,毕业

husky 工具配置代码检查工作流:提交代码至仓库前做代码检查

提示:这篇博客以我前两篇博客作为先修知识,请大家先去看看我前两篇博客 博客指路:前端 ESlint 代码规范及修复代码规范错误-CSDN博客前端 Vue3 项目开发—— ESLint & prettier 配置代码风格-CSDN博客 husky 工具配置代码检查工作流的作用 在工作中,我们经常需要将写好的代码提交至代码仓库 但是由于程序员疏忽而将不规范的代码提交至仓库,显然是不合理的 所

未来工作趋势:零工小程序在共享经济中的作用

经济在不断发展的同时,科技也在飞速发展。零工经济作为一种新兴的工作模式,正在全球范围内迅速崛起。特别是在中国,随着数字经济的蓬勃发展和共享经济模式的深入推广,零工小程序在促进就业、提升资源利用效率方面显示出了巨大的潜力和价值。 一、零工经济的定义及现状 零工经济是指通过临时性、自由职业或项目制的工作形式,利用互联网平台快速匹配供需双方的新型经济模式。这种模式打破了传统全职工作的界限,为劳动

Smarty模板引擎工作机制(一)

深入浅出Smarty模板引擎工作机制,我们将对比使用smarty模板引擎和没使用smarty模板引擎的两种开发方式的区别,并动手开发一个自己的模板引擎,以便加深对smarty模板引擎工作机制的理解。 在没有使用Smarty模板引擎的情况下,我们都是将PHP程序和网页模板合在一起编辑的,好比下面的源代码: <?php$title="深处浅出之Smarty模板引擎工作机制";$content=

Python脚本:TXT文档行数统计

count = 0 #计数变量file_dirs = input('请输入您要统计的文件根路径:')filename = open(file_dirs,'r') #以只读方式打开文件file_contents = filename.read() #读取文档内容到file_contentsfor file_content in file_contents:

bcolz文档

原文:http://bcolz.blosc.org/en/latest/reference.html First level variables bcolz.__version__'''bcolz包的版本。''' bcolz.dask_here'''是否检测到dask的最低版本。''' bcolz.min_dask_version'''需要dask的最低版本(dask是可选

3.比 HTTP 更安全的 HTTPS(工作原理理解、非对称加密理解、证书理解)

所谓的协议 协议只是一种规则,你不按规则来就无法和目标方进行你的工作 协议说白了只是人定的规则,任何人都可以定协议 我们不需要太了解细节,这些制定和完善协议的人去做的,我们只需要知道协议的一个大概 HTTPS 协议 1、概述 HTTPS(Hypertext Transfer Protocol Secure)是一种安全的超文本传输协议,主要用于在客户端和服务器之间安全地传输数据