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

来源 :上海交通大学 | 被引量 : 0次 | 上传用户:zhendongquan
下载到本地 , 更方便阅读
声明 : 本文档内容版权归属内容提供方 , 如果您对本文有版权争议 , 可与客服联系进行内容授权或下架
论文部分内容阅读
软件行业的技术文档写作是连接用户和复杂抽象的软件产品的桥梁,提高了软件产品的易用性,是软件产品不可缺失的一部分。本文旨在研究如何利用软件工具提高技术文档写作效率和提升技术文档写作质量从而提高软件的易用性。本文首先分析了技术文档的质量特性,归纳为任务导向性、准确性、完整性、清晰性、具体性、风格统一性、视觉有效性和易检索性,这八点是衡量技术文档质量的标准。本文研究了利用软件工具分离源文件和可交付文档,克服了所见即所得软件编辑技术文档的弊端,通过语法分析器将存储技术文档内容的源文件转换为多种形式的可交付技术文档,并验证了利用软件工具的效果。还对产品集源文件的整体管理进行研究利用软件工具整体管理产品集源文克服分散管理产品集源文件的弊端件,通过案例验证了有效的源文件管理对于产品集源文件的整体管理的重要意义。本文还研究如何使用自动化工具完成技术文档写作中重复性和机械性的操作,主要包括技术文档语言检查、索引条目整体管理、内容可用性检查、其他文档格式向DITA格式进行迁移。通过案例研究和用户调研,证明这些软件工具和方法能协助技术文档工程师克服资源的限制,高效率和高质量地交付技术文档。除此之外,本文还研究了技术文档表现形式,传统的技术文档表现形式的不足之处在于只能呈现静态信息,即难以提供有针对性和个性化的内容。为了提升用户体验,本文研究了基于XML编码的互动式文档模式的表现方式和实现方法,通过案例实践和用户调研,收集了关于传统静态文档和互动式文档的用户反馈,并验证了互动式文档的有效性。技术文档还需要关注软件行业的新趋势,从而提高软件易用性。云计算平台和移动互联为整个软件行业带来了革新和挑战,对于技术文档写作行业也不例外。因此,本文研究了利用软件工具提高针对云计算平台的技术文档和面向移动终端的技术文档。软件工具可以为云计算平台技术文档提供新特性。接着研究了技术文档如何加强对移动终端的支持,一方面是使用嵌入式帮助把技术文档嵌入到移动应用程序,另一方面是通过移动终端查看非移动终端产品的文档。
其他文献
唐代的燕子楼与张尚书和白居易有着种种密切的关系。自唐代之后,不少学者对此有着不用的解释。本文的作者是一位日本学者,他以域外人士的眼光,就燕子楼与张尚书和白居易的相
目的探讨大剂量甲泼尼龙冲击基础上联合PE,再串联CRRT、HP、HD多种血液净化技术的应用,治疗毒蜂致多器官功能衰竭的临床疗效。方法回顾性分析65例蜂蛰伤致多器官功能衰竭患者
"十二五"期间,"一带一路"尤其是"21世纪海上丝绸之路"战略的提出为我国海洋经济的发展带来重大机遇,同时也为山东省海洋经济带来了发展机遇。文章在分析"一带一路"建设为山东
对于已经存在的污染源,必须加大力度去治理。但事物总有两面性,很多时候污染物换个角度去看,或许就变成了一种资源。通过再生循环经济,能解决污染问题,还能开辟新的经济增长
临产开始时出现规律且逐渐增强的子宫收缩,其引起的疼痛可导致体内一系列神经内分泌反应,使产妇发生血管收缩、胎盘血流减少,酸中毒等,并且初产妇容易产生焦虑、紧张等情绪以
猪场健康管理是指在对生猪养殖过程中,对猪健康造成威胁的各项因素的科学管理。对猪场进行健康管理的最终目的是确保猪的健康成长,从而为人们提供高质量的猪肉。本文针对养猪
目的:肿瘤组织中的缺氧微环境启动肿瘤血管形成,但其具体机制尚不明了。本实验以A549人肺癌细胞,HepG2人肝癌细胞为研究对象,探讨不同缺氧时间后,Plexin B1这一与血管生成密
<正>在一般人心目中,纯文学与通俗文学泾渭分明,作品的文学性、真实性与可读性仿佛熊掌与鱼一般不可得兼.其实,却并不尽然.一些文学精品如《三国演义》、《水浒传》、《红楼
<正>甲状腺相关性眼病(Thyroid—associated ophthalmopathy, TAO)是由多种自身免疫性甲状腺疾病引起的眼部损害, 是临床最常见的眼眶疾病。表现为眼睑退缩、眼球突出、眼球
会议
电子商务的兴起与发展给传统税收带来了冲击和挑战,电子商务这种新兴的贸易方式与传统贸易方式在税收方面有许多不同之处。传统税收中的属地原则、税收管辖权、常设机构等一