软件文档编写存在的问题和解决办法的思考
2010-06-05 09:33
295 查看
和大多数人一样,我们明白软件文档的重要性,但不幸的是我们往往忽视它的产生和维护以及使用。
普遍在软件文档存在的问题:
错误的语法或拼错的词语
不完整
过时或不准确
过于冗长
未经解释的缩略语或专用术语
查找信息困难
存在问题的主要原因:
工程进度压力,优先考虑编码开发
编写文档需要花费成本,项目经理减少投入,只是装点门面
由开发人员编写文档
专用的技术文档编写者或业务分析师编写文档对技术部门把握不准确
解决方法:
写文档需要团队协作,开发人员和文档编写者利用彼此的长处,取长补短;如开发人员提供技术细节,然后文档编写者按照正确的语法组织和编辑内容。
文档质量评价标准:
应用性:文档是否提供相关信息
及时性:信息是否及时
准确性:信息是否正确
完整性:文档是否足够详细而不冗长
可得性:文档是否随时可得
可用性:你能否很快凭直觉找到所需信息
软件文档的目的:
传达一个系统的技术要素和使用方法
提供软件开发工程中需求、决策、行为、角色、职责的书面记录
普遍在软件文档存在的问题:
错误的语法或拼错的词语
不完整
过时或不准确
过于冗长
未经解释的缩略语或专用术语
查找信息困难
存在问题的主要原因:
工程进度压力,优先考虑编码开发
编写文档需要花费成本,项目经理减少投入,只是装点门面
由开发人员编写文档
专用的技术文档编写者或业务分析师编写文档对技术部门把握不准确
解决方法:
写文档需要团队协作,开发人员和文档编写者利用彼此的长处,取长补短;如开发人员提供技术细节,然后文档编写者按照正确的语法组织和编辑内容。
文档质量评价标准:
应用性:文档是否提供相关信息
及时性:信息是否及时
准确性:信息是否正确
完整性:文档是否足够详细而不冗长
可得性:文档是否随时可得
可用性:你能否很快凭直觉找到所需信息
软件文档的目的:
传达一个系统的技术要素和使用方法
提供软件开发工程中需求、决策、行为、角色、职责的书面记录
相关文章推荐
- Macfee 杀毒软件“签名文件存在8到29天”问题的解决办法!
- 《BI项目笔记》SSAS部署时发生的问题——元数据管理器中存在错误 解决办法
- SQLServer2008用户组或角色'*****'在当前数据库中已存在问题的解决办法
- 解决了一次点击 office 文档 Windows 10 文件资源管理器软件就卡死的问题
- 关于cocos2d实现H5声音播放存在问题的解决办法
- pl/sql程序编写中遇到的一些问题及解决办法
- KMPlayer 捆绑商业软件问题以及解决办法
- 挂载NTFS格式的移动硬盘,root权限下依旧存在权限不够问题的解决办法
- 如何在sublime里编译latex文档(+部分不常见问题及解决办法)
- [转载]MFC中建立新文档失败问题解决办法
- 当子级元素浮动时让父级元素高度自适应的三种方法(以及多个子集元素同时存在浮动和绝对定位时的问题的解决办法)
- dede文档添加联动菜单后,联动菜单却加载不出来问题解决办法
- Linux旧版本无法apt-get安装软件问题解决办法
- Eclipse中编写servlet时出现"The import javax.servlet cannot be resolved" 问题解决办法
- jQuery,Table表头固定插件chromatable存在的问题及解决办法
- RichTextEditor控件选中的字符和根据控件属性selection得到的字符存在差异的问题及解决办法
- 打开doc文档提示Word 遇到问题需要关闭以安全模式启动解决办法
- 《BI项目笔记》SSAS部署时发生的问题——元数据管理器中存在错误 解决办法
- Adobe有些软件出现“遇到问题需要关闭”问题的解决办法
- win7系统不兼容软件问题的解决办法