关于软件文档化的一些想法。

原创 2004年07月13日 14:28:00

国内关于软件文档的问题一直都有讨论,而声音主要聚集在两个方面:

1)软件文档很重要,它能够规范过程,保证组织利益

2)软件文档很费劲,它更新维护麻烦,会拖累组织。

而笔者发现大多数人、企业都处于“在思想上认可第一种思想,而在行动方面却不得不使用第二种路子”,面临这样的问题,笔者找到了一种折衷的解决之道,在此与大家共享:

在日常的交流讨论中,将原始的资料进行保存(例如纸上的草稿通过扫描仪扫描到电脑中,而在白板上的东西则将其用数码相机拍下来存入电脑),然后统一进行配置服务器。

对于一些重要的内容,再进行文档化,将这些资料做为附件,则可!

试一试,你一定会喜欢。

文档化说明的重要性

文档化说明的重要性
  • chenlycly
  • chenlycly
  • 2016年06月01日 20:11
  • 2247

对大学的想法

对大学生涯的回顾与想法为什么会想写这么个东西呢?? 原因有两点 1. 练练markdown 2. 吐槽一下自己虚度的光阴 对大学生涯的回顾与想法 大学做了什么 对于各个方面的看法 应该...
  • qq_16468937
  • qq_16468937
  • 2016年03月30日 22:56
  • 985

谈谈对工作的看法

好的团队能让你知道如何合作,如何沟通甚至是一个好的工作方式与习惯,一个好的领导除了能给你职业方面的培训,还会交给你如何形成自己的职业观、价值观,一群好的同事能让你不断地进步、快速的成长。一个好的行业会...
  • linux_zkf
  • linux_zkf
  • 2015年08月26日 08:44
  • 4133

Java基础---第六天 面向对象

一.Static关键字     1、static 静态         (1)、是一个修饰符,只能修饰成员(成员变量,成员函数),在内存中的共享区         (2)、  static St...
  • hopehe888999
  • hopehe888999
  • 2013年02月07日 00:52
  • 1004

池化方法总结(Pooling)

在卷积神经网络中,我们经常会碰到池化操作,而池化层往往在卷积层后面,通过池化来降低卷积层输出的特征向量,同时改善结果(不易出现过拟合)。 为什么可以通过降低维度呢? 因为图像具有一种“静态性”的属性,...
  • Daniel_djf
  • Daniel_djf
  • 2015年01月05日 21:27
  • 20779

关于团队合作的一些看法

我现在待的公司是一个分公司,在软件开发上经常需要和各个分部进行合作,而在这段合作中,我渐渐发现了一些不可避免的问题。 特此记录一下,希望以后注意并想办法解决。 1.时差导致的工作延误 ...
  • u011107827
  • u011107827
  • 2015年04月09日 16:41
  • 420

windows 内核文档化API/导出但未文档化API/未导出API

导出函数:顾名思义,出现在导出表(EAT)里面的函数,可以给外部调用的函数,验证是否为导出函数的方法,熟悉逆向的朋友可以使用LordPE之类的工具查看,当然也可以使用GetProcAddress或者M...
  • lixiangminghate
  • lixiangminghate
  • 2017年01月06日 16:15
  • 553

编写自文档化代码

创建优秀的代码意味着创建良好的文档化了的代码。我们编写代码的原因是要表达一套清晰的指令——不仅仅是对电脑,也是对那些以后需要维护或拓展这些指令的可怜傻瓜们。...
  • YhL_Leo
  • YhL_Leo
  • 2016年01月19日 21:27
  • 1188

我的创业劲儿,无可阻挡-JAVA学院张孝伟

导语:张孝伟,这个怀揣着创业梦想的农村小伙,为了报答父母的恩情,他开启了自己的逐梦之旅。友好的伙伴,火旺的生意,曾经让他如鱼得水。就在他满足于现状的时候,一场突如其来的事故,让他一夜间倾家荡产。他能否...
  • cdczbk
  • cdczbk
  • 2014年08月04日 14:23
  • 768

对redis数据持久化的一些想法

数据持久化通俗讲就是把数据保存到磁盘上,保证不会因为断电等因素丢失数据。 redis需要经常将内存中的数据同步到磁盘来保证持久化。redis支持两种持久化方式,一种是 Snapsho...
  • xyw591238
  • xyw591238
  • 2016年06月21日 18:02
  • 134
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:关于软件文档化的一些想法。
举报原因:
原因补充:

(最多只允许输入30个字)