写文档也是技术活
01:实践
关于多数开发同学来说,许多时分即厌烦没有研制文档,可是自己又不乐意常写文档,痛且倔强着;
程序员该不该写文档,与争论哪种编程言语最好相同,想撕的嘴不留情,该写的笔不停耕;
当自我的认识上去纠结一件作业要不要去做的时分,不妨停下来看一看,大的职场环境是怎么选择的,纠结天然就没必要了;
关于写文档这件作业,并不需求去考虑能带来哪些好处或许会占用多少时刻,用心去写天然明白当中利害;
最近两年听到不少搬砖的朋友说,公司现已把文档办理提升到财物层面,在重大版别推动过程中,预留文档输出的时刻,这可不是一般的大聪明;
从作业的这几年实践阅历来看,写文档准则上本着杂乱的事项细写,简单的事项简写或许不写,卷能够但又不闲的慌;
02:目录
互联网的产品,多少存在一定的虚拟属性,许多作业和想法也都具有明显的笼统感,假如缺乏文档的结构化描绘,时刻拉扯下很简单烟消云散;
这儿罗列一份在研制办理和职场中,或多或少都会接触到的文档内容,虽然结构杂乱,但随着时刻的沉积,其带来的价值远大于保护成本;
作业中涉及到的文档种类比较繁多,但就办理和沉积的动作来说属于那种重要但不紧急的作业,这样说并不是指研制流程中动作的时序能够紊乱;
顺着作业流程把该输出的文档做好,是比较正常的节奏,在特别情况下也能够先处理作业,再后补文档;
从开发的视点来说,假如是常规状态下的版别推动,那么在版别结束时各种相关文档就能够上传指定目录了;
可是作业中不乏许多生产环境突发的棘手状况,此刻团队天然优先处理,假如问题影响过大,在事后必然还要输出总结文档,便是阅历更是阅历;
03:模板
假如是个人的文档,短小精悍即可;可是作业文档需求有标准和风格上的约束,一般情况下根据一致的模板库即可;
在研制流程中,一般会环绕项目的进展办理文档,在该文档中会统筹流程中的中心内容,涉及各个阶段的进展保护;
根据项目进展办理的文档模板,在流程推动的过程中,不断补齐相关的中心内容,明晰准确的记录版别进展;
选用特定的模板写作业文档,本身就会起到标准的效果,在部分的日常办理中,需求阶段性的沉积和保护各类文档的模板结构,而模板的内容能够根据具体需求来定,在运用的过程中也需求经常优化;
假如文档模板足够丰厚,在一定程度上能够处理不想写文档的问题,在写文档这件事上之所以会劝退许多人,很大原因是缺少可用的文档模板;
当模板库中存在:项目进展、研制规划、测试用例、阶段总结、阶段规划等各种样例时,下载之后直接运用,编写中心内容即可,这样排斥写文档的情绪天然减少;
04:内容
文档的内容是价值所在,关于团队的协作来说内容短小精悍即可,让阅读文档的人能够快速准确的理解作业的信息;
一般需求输出文档的事项都比较杂乱,所以在内容上需求恰当的排版,杂乱的逻辑尽量运用图解来描绘,这样内容条理和思路都会很明晰;
关于其他细节方面的把控,比方阶段缩进、专业名词、空格等,一般本着:对内的文档尽量做好,对外的文档有必要做好的准则;
文档内容是考虑逻辑的呈现,在编写过程中也简单发现逻辑上的问题,再经过评审评论和完善内容,这样作业环绕文档在后续的过程中不会过度偏离主线;
关于开发这个人物来说,写文档是避不开的事,在一个项目上待的时刻久了,再看初期的代码,都觉得不是自己写的,更别说是杂乱的事务逻辑了;
在研制文档中,最常用的图解便是逻辑时序,再恰当的丰厚相关的内容,在一份图中能够包括流程、逻辑、交互、数据办理等各个中心节点;
开发的规划文档根本是几张图就能够描绘清楚的,一般涉及:事务流程图,逻辑时序图,数据结构图;
当杂乱的事务呈现在文档和规划图上时,其实便是给作业预设好了航线,当然有时分中途被逼返航或变道也不少见;
05:东西
工欲善其事,必先利其器,想快速做好一份文档,有必要得有趁手好用的东西才行,在多年写文档的阅历中,以下东西多少都试用过;
图中标红的东西,是个人在实践中觉得不错的东西,当下运用最多的是DrawIO和语雀文档,在免费的边界内足够日常运用;
由于作业中需求对接的事项比较多,很难一致协作的各方运用的文档东西,天然接触到的东西类型就很杂乱,关于团队内部来说,一般运用办公软件集成的东西,以便于一致办理;
写文档的习惯现已继续了许多年,东西的变迁也阅历了三次,从办公文档迁向Markdown,从线下迁移到线上,更换过一次文档东西;
时刻在变,文档类产品也在不断的更新换代,怎么寻觅自己顺手的东西,本着一个根本的准则:免费的领域内,支持在线办理,功用恰当丰厚即可;
最后共享一条写文档的理由:因为作业多而杂乱,所以要写到文档中,这样便能安心的忘了它。
END