文档划分

技术文档的书写

作为一个开发者,我常常在想到底我们怎么和周围的一些朋友交流。你的朋友里可能有对技术一窍不通的,有可能是你的同事,还有可能是你的导师或者技术总监之类。该用什么样的思维方式向他们分享一个知识。所以才有了下面的这段考虑。
文档分成三类:介绍文档,设计文档,分析文档

  1. 介绍文档
    介绍对象的概念和定义,运行所需的构成环境,背景,需求,合理性,可行性,初步构建逻辑框架。使得第一次接触的用户可以对对象有基本的认识。

  2. 设计文档
    设计文档要规划处设计的具体细节,包括通信协议,运行逻辑,启动流程,数据流,重要数据设计,重要的业务设计,重要代码结构设计,以及要指明初步的功能测试项等。以至于用户可以根据文档修复问题甚至重构整个工程。

  3. 分析文档
    分析文档是在普通开发者的角度分析一个未知的工程项目。编写这样的文档,具有很大的难度保证完全合理正确,需要开发者不断的修复,还要在工程不停的迭代中补充。编写分析文档,最终将达到设计文档的水准,所以需要突出几点,运行时序,工作流程,重要数据,具体的业务逻辑。其他开发者能够依据分析文档熟悉工程,修改工程问题等。

思考问题的方式

一个新生事物总要要经历产生,发展和完善。我们循着这个过程了解,熟析和深入研究它,是无可厚非的,也是确实合理没有问题的。但是大部分时候我们并不能稳稳地抓住这个脉络贯彻执行,总会有时间啊,任务啊等等太多的限制。所以我们需要有一个新的思维来解决问题,而不是学习知识

  1. 解决问题
    我们要相信任何问题最终能够被解决。假设一个系统整体是和谐的,问题让系统出现不和谐,所以解决思路也很直接,让它和谐。我们可以从整体认识系统后,再修改问题,这样可能少引入问题,但往往需要时间,在工作中我们常常只分析问题的局部,理解系统的局部原理,问题的成因,然后修改。解决问题不同于系统学习,而是属于积累性质的事情,我们得要常常积累这些点滴,这将是往后的宝贵经验。

  2. 学习知识
    系统学习知识不是一蹴而就的,我们要从各个角度切入,掌握整体,理解细节,对各种业务结构如数家珍一样熟悉。时间能让我们更深刻地学习一个系统。我们学习一个系统一定要能达到介绍文档和设计文档的水准。

承担责任和协调工作

  1. 承担责任
    喜爱你的工作,了解你的工作,主动承担责任,主动付出热情,主动协调人员。大家不会排斥主动付出的人,比如说主动接受任务,主动找人沟通,主动分享,主动反馈等,同时也能让自己工作的更轻松有效率。

  2. 协调工作
    中国人的性情是总喜欢调和这种的,譬如你说,这屋子太暗,须在这里开一个窗,大家一定不允许。但如果你主张摘掉屋顶他们就会来调和,愿意开窗了。
    鲁迅《无声的中国》

精致和自由

  1. 精致生活
    保持对生活的热情,这是一切一切的基础,失去希望的人,像个没有灵魂的机器,和他一起工作,会让你也渐渐失去热情,失去希望。我们自己不要做这样的人,保持热情,保持新鲜,去追寻美好的未来。

  2. 自由
    人的思想要自由,要乐于接受新知识,新的思维方式,新的模式。人又要有自己的判断方式和标准,并且能日新月异,不断完善自洽。

先写这么多吧!!!

你可能感兴趣的:(文档划分)