很多时候,我们所理解的「产品」概念,可能是某个软件或硬件,但其实《使用说明》等文档也是「产品」不可或缺的一部分,而好文档,会促成好「产品」的市场化,从事技术工种,能够对编写文档本身有一定的造诣,其实是一个不错的加分项。从去年开始,部门内部开始着手于开发自己的测试平台,里面集成了很多日常工作相关的小组件,初版的主体功能已经开发得差不多了,但是介绍功能的使用说明文档却还处于起步阶段,导致想要尝试系统的同事们操作起来比较繁杂。 于是组长找了组内相对细心的一名同事,专门负责相关文档的编写工作,并通过一种探索性测试的方式,从「使用者角度」去给不同模块编写最精简的入门操作指南。不过在笔者看来,更建议的工作模式是,开发者应该编写自己所负责部分的使用说明,毕竟他对内部的运行逻辑最为熟悉,编写文档考虑得可以更加全面。所以,技术从业者不要每天只顾着手头的开发任务,通过编写一份言简意赅的文档,让「产品」变得更易用,也同样重要。
|