关于软件文档，我的看法

自强不息

文档应该包括两大部分，一部分是清晰的代码结构和注释，比如Concurrent API就是这样，还有一部分是文字文档，包括三个小部分：一是开发文档，应该讲架构和功能；二是索引文档，详细介绍功能和参数，三是用户文档，包括安装和使用说明

文档最困难的莫过于版本的一致性，当软件升级后，一些obsolete的内容和新的feature很难同步。要是架构发生了变化，那就更困难了。一般document team都不是太精于技术，所以也会产生一些问题。

只能说任何事物永远都有改进的空间，但是同样也永远没有达到完美的程度

@2008 杨一. 版权所有. 保留所有权利

posted on 2010-06-29 18:26 杨一阅读(381) 评论(0) 编辑收藏所属分类: Other Tech

新用户注册刷新评论列表


只有注册用户登录后才能发表评论。




网站导航: 博客园博客园最新博文博问管理
相关文章: 关于ThreadLocal的内存泄露关于软件文档，我的看法多线程的知识 Ext Store Filter的实现和问题 Ext中Combo组件的联动封装前端框架动态组件和代码生成之间的选择 Javascript工作流引擎代码及实例实现Ext表单对checkBoxGroup的统一管理关于文本协议中二进制到文本的转码也谈普元

狂奔 lion

关于软件文档，我的看法

导航

公告

常用链接

留言簿(5)

随笔分类(55)

随笔档案(55)

相册

Java

其他技术

生活

最新随笔

搜索

积分与排名

最新评论

阅读排行榜

评论排行榜

自强不息