导言:越来越多的文档直接通过Web网页发布,这种发布媒介让读者对文档的及时性与准确性也有相较PDF文档更高的期望值。一方面,责任心让TW希望文档内容尽量准确;另一种方面,TW日常也需要一个可持续专心写作的工作计划,不被文档更新追着屁股跑。如何协调缓和这一对矛盾?
D.Q.T.I.一书 Easy to Use > Accuracy节给出了一系列很妥贴、实用的技巧。
- 针对网页内容制定更新计划,并严格执行。
- 将上述更新计划在网页上公布。
- 在网页中标明文档的最后一次更新日期。
-
在网页上提供用户反馈途径。
以下示例供参考 image.png
网友评论
对于操作类文档,评测两块:
* 外部测试:由测试工程师(有时会是开发)以及产品经理完成
* 文档内审:组内同事互审
文档评测要点:
1. 操作步骤是否正确无误;2. 对概念性问题的阐述与理解是否正确;3.概念阐述是否正确反映产品设计意图; 4. 表达是否通顺正确;5. 文档组织结构是否合理; 6. 对于在线帮助,测试链接是否有效;7. 文法是否遵循写作规范;8. 从近“小白”的角度,考查易懂性、逻辑合理性、文字简洁清晰性
产品经理侧重:2、3、4、5
测试人员侧重:1、2、4、5、6
内审:4、5、7、8
越写越多,我到时开个话题再细写。