美文网首页
程序员修炼之道,交流和文档

程序员修炼之道,交流和文档

作者: 大笑的篷蒿人 | 来源:发表于2022-01-15 18:34 被阅读0次

    今天在家里睡了一天,但是感冒似乎并没有缓解,仍然还有一点低烧,不得不说这个日更的督促威力还是非常的大,让我迷迷糊糊中也记着要更一更。

    接下来说的两点同样是我非常有感触的地方,说的是交流和文档

    英语也是编程语言,我没有去翻原版,不过我看了这个标题我就认为这个翻译有问题,应该翻成自然语言也是编程语言更好。当然,语言是为了交流,自然语言是为了人与人交流,编程语言是为了人机交流,本质上是作用相同的。

    从这个意义上来说编程能力强的人,自然语言能力一定也非常强。这里可能略有点神奇,难道编程更应该是一个偏文的学科。这个说法当然也有问题咯,实际上语言有两种能力,一是表达观点,传递信息。这个是基础,与编程语言是完全相同的。二是共情,通过我的语言,触动到你的背景,进而产生遐想和共鸣。这部分是编程语言暂时不需要的,但这一部分往往是一个文学家的过人之处。所以说编程能力好的人在表达的条理性和突出重点方面肯定是优秀的。

    拿我们每天都在打交道的story文档来做了例子,我在一年多以前给BA同学们吐槽过一篇怎么写好的story的文章,有兴趣的可以看。这里就不重复写了。

    项目文档反思,需求文档

    实际上要把交流和文档做好,我觉得也非常简单。就是六个字,元素,条理,套路

    先说套路,很多人觉得套路不是一个褒义词,不好意思,在我通常的表述中套路和甩锅至少不是贬义词。套路是什么,说白了是一个框架,对,框架这个名词听上去就要高大上一点了。这个套路在我大概10年以前随一位高手写材料的时候感受颇深,一直到处分享给大家,说一个文档主要说清楚三个问题即可:为什么要干?要干什么?要怎么干?非常好的贴合了我们的story,背景,为什么要做,solution,要干什么,design 文档,怎么干。在不同类型的文档中,上面三点可能顺序详略有所变化,但这个套路基本上是通用的。

    然后来说条理,条理实际上是理科生的强项,如果说前面的套路将文档分成了三大块,那么条理就是对这三大块细化,形成提纲,比如我们读的这本书,将100个tips归类到十几章,为什么这么归,每一章中的tips为什么是现在这个顺序,都是条理的体现,一般来说重点突出,用一些分项1,2,3来表述是简明的做法

    最后说说元素,是说每一个细节点应该怎么来表述,这个很多时候是我吐槽BA的,小学语文说时间,地点,人物,事件。当然我们在项目文档中更合用的应该是在什么地方,将什么行为改成什么行为。OK结束,上面这三个元素正好,缺了有问题,多了有画蛇添足之感反而不够清晰。story文档是这样,实际上思考问题的思路也是这样的。

    最后推荐大家看一本讲文档套路(理清思路)的书,金字塔原则。

    相关文章

      网友评论

          本文标题:程序员修炼之道,交流和文档

          本文链接:https://www.haomeiwen.com/subject/zltxhrtx.html