建立文档结构和规范，文档倒推前端产品建设

文章转载来源：公众号：技术传播李琳 作者：付涛 

 

我的一个业务同学，开始关注资料，向我提了问题：如何建立文档结构和规范、如何通过文档倒推前端产品建设。

我试着抛砖引玉的回答，并跟多位资深同行开展云交流，很有趣，大家都是在一个行业中，可交流的角度却是多样的，也能从别人的观点中受到启发。

我整理了出来，分享给大家，也想听听各位的看法。

 

 

一、建立文档结构和规范

1、向业务方“收集”、“分类”、“整理”已有文档，拿回来分析与长期的业务/产品规划，进行文档配套，不一定是要增加文档种类，也可能是减掉或合并“用不着”的文档，能建立最基础的文档体系，继续发展，从用户反馈中，不断迭代文档类型和内容。

2、问4个问题：目标用户群是谁？文档使用场景？交付给谁？在哪个国家？这4个问题能有效界定用户的知识储备；文档用于指导“快速上手”还是指导用户解决问题；产品PM需要重点推介产品的Key Feature，售后部门需要给用户一些防呆信息，质量部门要声明特定环境下的产品性能限制；外部法律法规的合规性要求。

3、如果是从头开始的，最好先简单定义大框架，边跑边看。

4、文档体系建立，经过收集整理，进行查缺补漏，尽量做到交付正交。把文档交付的时间点和业务流程绑定，就形成文档交付流程。

5、文档体系，可以参照ISO9001体系，有完整的结构和规范建议，包括后续的内审外审等措施 。

 

 

二、文档推动产品建设

1、我经历过的文档实践，几乎都没有成果。但可以把角度切换为“文档迭代管理”，云产品迭代快，要跟着用户需求走，跟着市场变化走，再好的文档也跟不上这节奏。文档迭代管理，也就是内容管理，可以从这几处着手：内容同源、内容质量沙盘、用户反馈。

2、传统的静态文档实际上很难推动产品建设，最主要的原因就是承载形式限制，例如PDF，印刷品。静态文档的主要使命是传达信息，即单向的信息转移。不能和用户形成互动，也就很难推动产品的建设。

动态文档就可以实现信息传输和互动，并按照用户的需求，实现定量定向精准信息投放，可以和用户实现一定形式的互动，并通过用户的反馈最终推送到产品开发团队，实现正向推动产品建设。

3、在开发设计阶段，进行扩大评审，把开发、测试、服务、资料的人一起纳入评审，提供改进。

4、间接影响到产品建设：技术写作者作为与用户共情的身份，在产品设计评审阶段，给出意见或建议；通过用户对技术文档的反馈数据，分析出产品设计不足的地方，提炼总结后，输出给产品团队。

坐而言，不如起而行。希望跟大家多交流实践的收获，欢迎分享你的看法。