软件文档编写存在的问题和解决办法的思考
来源:互联网 发布:浙大软件学院学费 编辑:程序博客网 时间:2024/05/15 05:36
和大多数人一样,我们明白软件文档的重要性,但不幸的是我们往往忽视它的产生和维护以及使用。
普遍在软件文档存在的问题:
错误的语法或拼错的词语
不完整
过时或不准确
过于冗长
未经解释的缩略语或专用术语
查找信息困难
存在问题的主要原因:
工程进度压力,优先考虑编码开发
编写文档需要花费成本,项目经理减少投入,只是装点门面
由开发人员编写文档
专用的技术文档编写者或业务分析师编写文档对技术部门把握不准确
解决方法:
写文档需要团队协作,开发人员和文档编写者利用彼此的长处,取长补短;如开发人员提供技术细节,然后文档编写者按照正确的语法组织和编辑内容。
文档质量评价标准:
软件文档的目的:
传达一个系统的技术要素和使用方法
提供软件开发工程中需求、决策、行为、角色、职责的书面记录
- 软件文档编写存在的问题和解决办法的思考
- 从文档的编写问题引发的一些思考
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目开发的文档编写标准化
- 软件项目的文档编写方法
- Doxygen 编写软件参考文档的工具
- 软件项目开发的文档编写标准化
- 软件开发需要编写的那些文档
- 软件开发需要编写的那些文档
- 软件项目开发的文档编写标准化
- 软件项目开发的标准化文档编写
- Typora:功能强大的轻量级文档编写软件
- 传统BI存在的问题及解决办法
- 软件项目中存在的问题
- 程序编写和调试的思考
- iPhone入门学习——UITabBarController学习笔记
- php+mysql事务处理的简单实现
- 执行windows计划任务没设置用户密码怎么办?
- 执行sql语句一直弹出保存对话框的解决办法
- const 与 readonly知多少
- 软件文档编写存在的问题和解决办法的思考
- [QT] QDataStream类参考
- QI for IEnumVARIANT failed on the unmanaged server. (CustomMarshalers)
- 关于新手学习VC/MFC的前途的讨论
- 在建立与服务器的连接时出错。在连接到 SQL Server 2005 时,在默认的设置下 SQL Server 不允许进行远程连接可能会导致此失败
- windows计划任务执行php程序
- 地线的可靠性设计
- 前台接收sql存储过程输出参数的例子
- 在Linux系统下如何调整文件打开方式