目录
1绪论----------------------------------------------------------------------------------------------1
1.1研究背景----------------------------------------------------------------------------------1
1.2国内外研究现状-------------------------------------------------------------------------1
1.2.1软件行业中技术文档的价值---------------------------------------------------1
1.2.2撰写技术文档的方法-----------------------------------------------------------2
1.2.3技术文档的开发过程-----------------------------------------------------------2
1.2.4技术文档的发布形式-----------------------------------------------------------2
1.2.5技术文档的翻译-----------------------------------------------------------------3
1.3研究内容与创新点----------------------------------------------------------------------3
1.4论文结构安排----------------------------------------------------------------------------3 2相关概念与知识--------------------------------------------------------------------------------5
2.1技术文档写作的范畴和定义----------------------------------------------------------5
2.2技术文档写作的特点-------------------------------------------------------------------5
2.3技术文档写作内容的质量特性-------------------------------------------------------6
2.4本章小结----------------------------------------------------------------------------------9 3利用软件工具管理技术文档源文件-------------------------------------------------------10
3.1技术文档源文件-----------------------------------------------------------------------10
3.1.1所见即所得编辑软件的弊端-------------------------------------------------10
3.1.2利用软件工具分离源文件和可交付文档的研究-------------------------10
3.1.3构建可交付技术文档----------------------------------------------------------14
3.1.4利用软件工具分离源文件和可交付文档的效果验证-------------------15
3.2产品集源文件的整体管理-----------------------------------------------------------16
3.2.1分散管理产品集源文件的弊端----------------------------------------------16
3.2.2利用软件工具整体管理产品集源文件的研究-----------------------------16
3.2.3利用软件工具整体管理产品集源文件的效果验证-----------------------18
3.3本章小结--------------------------------------------------------------------------------24 4利用自动化工具完成重复操作-------------------------------------------------------------26
4.1技术文档语言检查--------------------------------------------------------------------26
4.1.1人工进行语言检查的弊端---------------------------------------------------27
4.1.2利用自动化工具进行语言检查的研究-------------------------------------28
4.1.3利用自动化工具进行语言检查的效果验证-------------------------------31
4.2技术文档索引管理--------------------------------------------------------------------32
4.2.1人工管理索引的潜在问题----------------------------------------------------33
4.2.2在源文件中创建索引----------------------------------------------------------33
4.2.3利用自动化工具进行索引管理的研究-------------------------------------34
4.2.4利用自动化工具进行索引管理的效果验证-------------------------------35
4.3技术文档可用性检查-----------------------------------------------------------------36
4.3.1检查技术文档对特殊人群的可用性----------------------------------------37
4.3.2检查内嵌链接的可用性-------------------------------------------------------39
4.4技术文档源文件格式的迁移--------------------------------------------------------40
4.4.1利用自动化工具从HTML转换为DITA----------------------------------40
4.4.2使用自动化工具从其它文档格式转换为DITA--------------------------41
4.5本章小结--------------------------------------------------------------------------------42 5交互式文档模式-------------------------------------------------------------------------------43
5.1传统技术文档表现形式--------------------------------------------------------------43
5.1.1面向消费者的软件产品的技术文档----------------------------------------44
5.1.2企业级软件产品的技术文档-------------------------------------------------44
5.2传统技术文档的弊端-----------------------------------------------------------------45
5.3交互式文档模式的研究--------------------------------------------------------------45
5.3.1交互式文档表现方式----------------------------------------------------------46
5.3.2使用软件工具实现交互式文档的研究-------------------------------------48
5.4使用软件工具实现交互式文档的案例实践--------------------------------------49
5.5交互式文档的效果验证--------------------------------------------------------------51
5.6本章小结--------------------------------------------------------------------------------53 6针对云计算平台和面向移动终端的技术文档-------------------------------------------54
6.1云计算平台的技术文档--------------------------------------------------------------54
6.1.1利用软件工具提高云计算平台技术文档的针对性----------------------54
6.1.2利用自动化工具收集用户反馈----------------------------------------------55
6.2面向移动终端的技术文档-----------------------------------------------------------57
6.2.1在移动应用程序中嵌入技术文档-------------------------------------------57
6.2.2软件工具支持用户在移动终端访问技术文档----------------------------60
6.3本章小结--------------------------------------------------------------------------------65 7总结与展望-------------------------------------------------------------------------------------67
7.1总结--------------------------------------------------------------------------------------67
7.2展望--------------------------------------------------------------------------------------67参考文献--------------------------------------------------------------------------------------------68致谢--------------------------------------------------------------------------------------------------70攻读学位期间发表的学术论文目录-----------------------------------------------------------71