数行样明白软件文档重性幸务开始前少阅读文档相反常常视线清父母样装配孩子行车落两零部件没装 果明白文档重性什更常呢?然许软件文档存问题:
· 错误语法拼错词语
· 完整
· 时准确
· 冗长
· 未解释缩略语专术语
· 查找信息困难
存问题原软件文档常常退居次位工程预算迫优先考虑开发程中活动利润方编写文档需成常常成项观活动通常认没重作应该量避免许项目理认客户需文档装点门面
软件文档质量差外原文档撰写者许应程序开发理认软件文档编写软件开发程标准组成部分求开发员编码程中产出文档
种做法理行通没考虑开发员编写文档力简单说技术员开发软件编写文档解决问题许应程序开发理雇佣专业技术文档编写者业务分析师期改进软件文档质量遇难题:专业编写者业务分析师技术水限
解决问题考虑需编写文档文档预期读者般规写文档需团队协作样允许开发员文档编写者利彼长处取长补短例果预期读者系统设计师开发员需提供技术细节然文档编写者正确语法组织编辑容考虑预期读者专门编写者软件文档质量取决性6方面评价性:
· 应性:文档否提供相关信息?
· 时性:信息否时?
· 准确性:信息否正确?
· 完整性:文档否足够详细会太拘泥细节?
· 性:文档否时?
· 性:否快直觉找需信息?
软件文档目标传达系统技术素方法第二目标提供软件开发程中需求决策行角色责书面记录实现两目标软件文档真正提供意义信息
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档