利用软件工具提高技术文档写作质量和效率方法的研究

摘要

软件行业的技术文档写作是连接用户和复杂抽象的软件产品的桥梁，提高了软件产品的易用性，是软件产品不可缺失的一部分。本文旨在研究如何利用软件工具提高技术文档写作效率和提升技术文档写作质量从而提高软件的易用性。
　　本文首先分析了技术文档的质量特性，归纳为任务导向性、准确性、完整性、清晰性、具体性、风格统一性、视觉有效性和易检索性，这八点是衡量技术文档质量的标准。
　　本文研究了利用软件工具分离源文件和可交付文档，克服了所见即所得软件编辑技术文档的弊端，通过语法分析器将存储技术文档内容的源文件转换为多种形式的可交付技术文档，并验证了利用软件工具的效果。还对产品集源文件的整体管理进行研究利用软件工具整体管理产品集源文克服分散管理产品集源文件的弊端件，通过案例验证了有效的源文件管理对于产品集源文件的整体管理的重要意义。
　　本文还研究如何使用自动化工具完成技术文档写作中重复性和机械性的操作，主要包括技术文档语言检查、索引条目整体管理、内容可用性检查、其他文档格式向DITA格式进行迁移。通过案例研究和用户调研，证明这些软件工具和方法能协助技术文档工程师克服资源的限制，高效率和高质量地交付技术文档。
　　除此之外，本文还研究了技术文档表现形式，传统的技术文档表现形式的不足之处在于只能呈现静态信息，即难以提供有针对性和个性化的内容。为了提升用户体验，本文研究了基于XML编码的互动式文档模式的表现方式和实现方法，通过案例实践和用户调研，收集了关于传统静态文档和互动式文档的用户反馈，并验证了互动式文档的有效性。
　　技术文档还需要关注软件行业的新趋势，从而提高软件易用性。云计算平台和移动互联为整个软件行业带来了革新和挑战，对于技术文档写作行业也不例外。因此，本文研究了利用软件工具提高针对云计算平台的技术文档和面向移动终端的技术文档。软件工具可以为云计算平台技术文档提供新特性。接着研究了技术文档如何加强对移动终端的支持，一方面是使用嵌入式帮助把技术文档嵌入到移动应用程序，另一方面是通过移动终端查看非移动终端产品的文档。

目录

1 绪 论

1.1 研究背景

1.2 国内外研究现状

1.3 研究内容与创新点

1.4 论文结构安排

2 相关概念与知识

2.1 技术文档写作的范畴和定义

2.2 技术文档写作的特点

2.3 技术文档内容的质量特性

2.4 本章小结

3 利用软件工具管理技术文档源文件

3.1 技术文档源文件

3.2 产品集源文件的整体管理

3.3 本章小结

4 利用自动化工具完成重复操作

4.1 技术文档语言检查

4.2 技术文档索引管理

4.3 技术文档可用性检查

4.4 技术文档源文件格式的迁移

4.5 本章小结

5 交互式文档模式

5.1 传统技术文档表现形式

5.2 传统技术文档的弊端

5.3 交互式文档模式的研究

5.4 使用软件工具实现交互式文档的案例实践

5.5 交互式文档的效果验证

5.6 本章小结

6 针对云计算平台和面向移动终端的技术文档

6.1 云计算平台的技术文档

6.2 面向移动终端的技术文档

6.3 本章小结

7 总结与展望

7.1 总结

7.2 展望

参考文献

致谢

攻读学位期间发表的学术论文目录