FavoriteLoading
0

文档开发流程中的质量管控活动

今天上海翻译技术沙龙活动中Nate张勇老师和两位德国朋友分享的技术写作干货满满,恐怕大家都意犹未尽吧。我就借花献佛给大家编译一些文档开发流程中的质量管控方面的知识。

之前我们在中分享过文档开发的流程如下,

在每一个阶段,我们都会有如下的质量管控活动。

接下来,我们来对每一个活动做个解释说明。

Project Planning 文档项目计划

文档项目计划是需要被各个干系人来审查,比如,产品市场经理,产品研发,销售以及其他干系人等。  项目划包含文档项目的战略,来说明用户的需求,以及文档开发的规格书,文档开发活动,日程,角色和交付物。文档开发项目经理应该积极的协调各个干系人去做文档产品的计划审查,而不要消极地等待干系人去对我们的审查需求邮件进行回复。

Product Requirements 产品需求

产品需求应该给有一定程度用户信息需求的详细信息。这些用户需求信息应该体现在文档项目计划中去。这些需求信息应该被信息开发管理和项目管理人员复核,主要审核需求的完整性,和文档开发活动的相关性,以及日程的影响。

User and task Analysis 用户和任务分析

用户和任务分析是我们确定文档中内容的主要基础。一个全面而完整的用户和任务分析可以直接帮助我们选择内容,内容的详细程度,以及信息内容的可用性和流程。

Customer Feedback 客户反馈

文档信息质量管控的第一步和最后一步都是客户反馈,在项目的初期,客户反馈可以在信息架构和内容研发方面指导我们。在项目的尾声,客户反馈可以帮助我们评估文档研发的成功与否。客户反馈的形式多种多样,有网络调查,打印的或者在线的调查表,客户访谈,或者从我们的客户经理,销售,产品经理,培训等等人员或者活动中搜集过来。

Information Architecture 信息架构

充分获取体现了用户和任务分析,以及客户反馈的信息架构,为信息文档开发提供了一个基本准则。信息架构主要确定交付物的设计,主题的设计,内容主题之间的关系。

Structure Review 结构审核

对于主题和其他内容的结构审核,验证是否信息文档开发严格遵守了信息架构。同样也对我们技术写作的句式,以及是否遵循了已经设计好的XML 内容Tag的应用,从而保证我们的DTP流程和输出流程中少出问题。

Developmental Editing 研发编辑

研发编辑主要是对我们的草稿主题在Style Guide,内容可读性等等方面的编辑审核,这个主要有资深的技术写作来帮助初级技术写作进行校对编辑的。

Subject-Matter Expert Review SME 审核

研发团队以及服务团队 (法律法规,知识产权,隐私策略,安全策略等)对文档等进行专业领域的审核,避免文档在某个特定领域的内容没有问题。

Validation Testing 验证测试

验证测试保证文档和软件界面一致,保证在流程和步骤方面一致。验证测试可以被技术写作人员来完成,也可以找相应的测试人员来完成,或者有相应的SME来完成。确保产品操作,流程,不走完全一致,准确。

10  Usability Testing 可用性测试

可用性测试主要是确保用户可以按照文档说明能成功的完成所说明的任务,可以方面地定位某个内并且能理解某个概念。可用性测试一般要求实际的用户对产品文档按照实际的流程和步骤进行操作,并且由具有可用性测试经验的人员进行观摩。

11  Copyediting 文档审校编辑

文档审校对文档的全文做 Style Guide,专属领域的规范要求,拼写,语法,标点符号等进行全方位的校对编辑。这个任务主要是技术写作之间相互进行复核。

12  Production Editing 生产输出审校编辑

生产输出编辑主要是确保我们的文档研发在最后的出版物生成,以及格式转换方面的审校编辑。主要是看看文档的机构和输出的流程,格式,是否有异常,确保能输出所设定的格式,PDF,HTML。这个工作主要有技术写作或者专门的Production Engineer来完成,确保文档发布成功。

支付宝打赏支付宝打赏 微信打赏微信打赏

如果文章对你有帮助,欢迎点击上方按钮打赏作者

暂无评论

发表评论

电子邮件地址不会被公开。 必填项已用*标注

arrow grin ! ? cool roll eek evil razz mrgreen smile oops lol mad twisted wink idea cry shock neutral sad ???

扫码关注语沃世界

扫码关注语沃世界