软件文档起前节提种桥梁作助程序员编制程序助理员监督理软件开发助户解软件工作应做操作助维护员进行效修改扩充文档编制必须保证定质量质量差软件文档仅读者难理解者造成许便会削弱软件理(理员难确认评价开发工作进展)增高软件成(工作迫返工)甚造成更加害果(误操作等) 造成软件文档质量高原: ·缺乏实践验缺乏评价文档质量标准 ·重视文档编写工作文档编写工作安排恰 常见情况软件开发程中出进度分阶段时完成文档编制工作开发工作接完成时集中力时间专门编写文档方面程序工作相许编制文档感兴趣程序工作完成应付求提供文档赶写出样做法高质量文档实际真正高质量文档容易应认识文档工作予足够重视外常常需编写初稿听取意见进行修改甚重新改写程 高质量文档应体现方面: ①针性 文档编制前应分清读者象类型层次读者决定样适应需例理文档面理员户文档面户两类文档应开发文档(面软件开发员)样软件专业术语 ②精确性 文档行文应十分确切出现义性描述课题干文档容应该协调致应没矛盾 ③清晰性 文档编写应力求简明配适图表增强清晰性 ④完整性 文档应完整独立应成体系例前言部分应作般性介绍正文出中心容必时附录列出参考资料等课题文档间部分相重复必例项目户手册操作 册中关项目功性实现环境等方面描述没差特避免文档中出现转引文档容情况 段落未具体描述见××文档××节方式读者带许便⑤灵活性 软件项目规模复杂程度着许实际差律图6列文档针中等规模软件言较较简单项目做适调整合户手册操作手册合成户操作手册软件需求说明书包括数求掉数求说明书概设计说明书详细设计说明书合成软件设计说明书等 ⑥追溯性 开发阶段编制文档阶段完成工作着紧密关系前两阶段生成文档着开发工作逐步扩展具定继承关系项目开发阶段间提供文档必定存着追溯关系例某项软件需求必定设计说明书测试计划户手册中体现必时应做踪追查
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档