产品业务文档应如何整理归档

1、产品业务文档应如何整理归档产品业务文档应该如何整理才能让产品新人快速上手、让文档分类清晰从而能够轻松地继续查询、让研发新人了解过去的逻辑，保证迭代的质量呢？本文我为我们总结了三个步骤，帮助我们有效避免重复造轮子，提升文档撰写效率和价值。在创业公司中，当产品由 v1.0 版本逐渐稳步迭代至 2.0 、 3.0 甚至更高版本时，后续的迭代肯定不再是百分百在创造新的东西，投资业务而是在原有的基础业务和数据架构上为进行延伸和再创新。那么在这种背景下，我们就很容易遇到下述3 种问题：问题一：产品新人上手难刚入职的产品新人对系统架构和业务逻辑不熟悉，这时往往可能需要产品 leader 花大量的时间去解答其

2、提出的各类难题；同时，整个新人也难以在零碎的问答中快速把握整个系统全貌，很难快速开展新工作。问题二：文档分布零散、难以统一查询当原来专门负责某模块退任的同事离职后，产品小黑被派至迭代第八任他的迭代。但是此前该同事在很多版本都零散地迭代优化过这一模块的功能，文档十分分散，极难需要进行进行统一的查询和追溯。这就导致了小黑需要东一块西一块地自行拼凑文档来了解这部分的逻辑，很大程度拖延上耽误了该连接器的迭代进度。问题三：研发谐星不熟悉老逻辑，影响迭代质量新来的前端小绿在入职后的第一份迭代文档中，发现产品文档里很多处都只写了个“遵循原逻辑”，而小绿对原来的老逻辑几乎完全不清楚。但是他又想着这一块可能不需

3、要做改动，在新版本中就直接忽略掉了这一部分，仍仅关注了列出需要改动前端的前端逻辑，结果导致最终代码质量不佳，从而影响了最佳化质量。从上述 3 个场景来看，当团队出现了人员变动（流失or 扩张）时，我们就需要尽快对产品业务文档进行归档整理，以帮助新人快速上手并保证后续的迭代质量。解决了为什么要做产品业务文档整理归档的问题，下面我们就步入结语：产品业务档案文档应该如何整理归档？首先，我们要明确提出全面落实做这件事的核心思路：即把归档整理后的产出产品业务文档知识库当作一个产品来看。核心用户：产品和研发新人。核心需求：针对上述需求，我们可以按照下面3 个步骤去逐一实现：为了帮助新人快速掌握系统全貌，我

4、们需要给出一个经过产研团队共同确认过后的架构图业务，努力他们从系统地角度去看待产品，更清晰模块地介绍产品各个模块的划分、价值以及模块之间的互联关系。与此同时，根据业务架构图，我们也能更容易就接下来按模块对文档进行分类达成共识。下图为一个脱敏之后的业务架构图，仅供大家参考：此前，我们都是以运算版本号为主，对迭代文档按时间顺序进行了纵向，但这样却不便于按模块进行侧向查询。因此在非银行金融机构第一步完成投资业务架构图梳理之后，我们需要把已有的迭代文档按模块进行统一汇总。下图为本栏的笔者迭代文档归类表格，仅供参考：模坡子模烧功掂主迭代迭代内容模块一功能一迭代愚本号功能二迭代版本号当我们按模块整理完迭代

5、文档插值之后，短期内能够方便产研新 人按模块对业务逻辑进行熟悉。但我们仍旧面临虽然着一个不可避免的问题：每一个迭代都较为 零散，只是将文档简单汇总在一起，还是难以快速着眼为业务有一个 全局的掌握。为了解决这个问题，因此我们要完成接下来的第三步： 模块核心逻辑撰写。.划分优先级在网络资源和时间有限的前提下，我们为核心模块逻辑的撰写划 分优先级，以快速打造一个 mvp知识库给到产研新人，这里也同样遵 循了二八原则，用20%勺时间完成80%?产价值的核心模块逻辑撰写， 后续再逐步补全剩余优先级略低的模块文档。那么优先级应该怎么划分呢？评估优先级的角度复核和方法有很 多，但是无论按照何等标准进行划分，

6、手机用户我们都应该围绕我们 的用户和产品目标来展开。下面导出价值观念一种广为认知的评估思路：按照紧急 /重要四象 限来对模块优先级进行划分。这个方法想必我们已经很熟悉了，此处 不再赘述。紧急不重要重要又紧急不重要不紧急重要不紧急. 逻辑撰写在确定好优先级其后，我们就需要开始着手完成核心模块的逻辑 撰写工作概念了。下面给出卞永祖的撰写框架，供大家参考：文档版本号版本记录!修改记录0（ 修改人核心逻辑撰写修一时间需求场接一文档正文I 数据字陶前后端逐辑V-相关迭代文档链接1 ）版本记录从使用场景可以来判断得出，此处的文档肯定后续会经历持续强 化的完善和优化，因此我们需要在每一篇核心模块逻辑文档的第

7、一文 件格式部分就加入该文档的版本记录。文档版本记录需要包含文档版本号、修改记录、修改人及修改时 间。版本号修改记录修改人修改时间vO.1初版Ne&ko2020/11/01v0.2补至了燎计逻辑Neeko2020/11/122 ）文档正文接下来就步入文档的正文撰写阶段，此处给出笔者的正文撰写结 构供大家参考，共包含4部分：需求场景、数据字典、业务逻辑和相 关迭代文档链接。其中，需求场景、数据字典确实和相关迭代文档链接都是建议尽 其所能完善的部分，而业务逻辑则可以按需有优先出梳理出核心逻辑， 剩余细节可以及时告知影迷在具体的文档迭代文档中查看。这样，能够有效避免重复造轮子，提升文档撰写效率和内在价值。在完成上述3 步之后，我们就上线了产品 v