美文网首页
实施:同源下发,保证内容一致性 | 技术传播

实施:同源下发,保证内容一致性 | 技术传播

作者: BGRichi | 来源:发表于2019-12-19 13:45 被阅读0次

如果存在多份文档包含相同内容,且开发责任人隶属于不同部门,彼此相对独立。那么,如何避免重复造车轮,降低开发成本;同时,文档间相关内容同步刷新,保证对外发布的一致性?最近,我与同事小伙伴就在尝试协调解决这样一个问题。

背景

现有多种类型的文档中,均包含产品规格。包括但不限于:

- 产品白皮书

- 用户手册

- 快速安装指导

各类文档的开发责任所属部门不同,彼此之间相对独立地进行文档开发。

各类文档分别定义规格项,既有侧重,又有交集。

问题

由此造成的问题是:

(1) 开发成本高。

- 不同文档分别输出规格信息,重复造车轮;

- 信息来源多元,管理难度大;

- 反复确认相同信息;

- 如单一文档发生规格变更,难以同步至其他文档,造成信息不一致。

(2) 信息质量差。

- 术语不一致:不同文档的相同规格项采用不同术语。

- 参数不一致。

(3) 解决方案

输出唯一确定的产品规格清单,供下游文档引用。

规格清单为研发内部文档,用于与周边部门对齐产品信息。

价值

产品规格清单的价值在于:

- 降低文档开发成本。避免重复造车轮。

- 降低沟通成本。避免重复确认相同信息;明确信息责任人。

- 保障信息质量。唯一信息源,易于同步,确保全局信息一致性。

实施计划

实施流程如下图所示:

步骤1:定义规格项。

确定规格清单的列表项。可分为以下两个子步骤:

整理规格项:基于已有资料,最大化地列出可选规格项;

确定规格项:规格使用者确定规格需求;统一规格项术语。

规格使用者可能涉及:

- 产品白皮书:市场;

- 用户手册:文档;

- 快速安装手册:硬件开发。

规格项原则上包括以下内容:

- 体现产品基本信息;

- 体现产品功能亮点;

- 体现产品技术参数;

- 体现产品关键指标;

- 满足相关行业标准。

步骤2:定义规格项责任人。

以规格项为单位,指定审核签发责任人。

该责任人对对外发布的规格参数的正确性负有责任。

步骤3:开发规格清单。

基于现有资料,根据规格项定义(参阅步骤1),输出规格清单初稿。

步骤4:评审规格清单。

由规格项责任人(参阅步骤2)评审并确认规格项。

步骤5:发布规格清单。

提供可靠的产品规格信息,供下游文档引用。

步骤6:使用规格清单。

获取规格清单,根据当前文档的信息需求,选取相关规格项。引用部分无需进行内容评审。

步骤7:维护规格清单。

如产品变更,需同步刷新规格清单。

步骤8:反馈规格需求。

如规格清单使用者反馈新增需求,需刷新规格清单。

实施难点及解决办法

难点:

- 对外宣称产品规格涉及市场策略,非单纯产品实测数据;

- 决策部门众多,协调成本高,难以达成一致。

解决办法:

- 针对每规格项指定唯一责任人,确定参数正确,降低沟通成本;

- 指定相关责任人,集中会议评审,共同决策参数正确,避免部门分歧。

最后,附上完整思维导图:

其他推荐:

企业级信息管理系统初创方案构思 | 技术传播

技术传播是一片蓝海| 技术传播

访谈:TC无处不在,只是我们没有发觉 | 技术传播

这次他们说好要“讲真的” | 传播

在座都别吵了,你们还有我| 技术传播

一本培养强迫症患者的说明书 | 技术传播

就像用心做好日本料理 | 技术传播

顽固的老头子与无聊的说明书 | 技术传播

转战新媒体 | 技术传播

评测:王者荣耀的用户帮助系统 | 技术传播

让爸爸妈妈也能享受到科技发展带来的便利 | 技术传播

相关文章

  • 实施:同源下发,保证内容一致性 | 技术传播

    如果存在多份文档包含相同内容,且开发责任人隶属于不同部门,彼此相对独立。那么,如何避免重复造车轮,降低开发成本;同...

  • session一致性保证

    目录 一致性保证 一致性保证 保证session一致性的架构设计常见方法: session同步法:多台web-se...

  • 037海路得+内容运营二

    《运营之光》第三章 3.PGC型内容的产出 单篇的内容保证质量,长期的文章保证一致性和长期规划。 单篇内容的产生由...

  • ajax-2-同源策略&跨域

    同源策略 URL:协议+域名+端口+路径 同源:协议+域名+端口 相同 为什么需要同源策略:保证Web安全 什...

  • 区块链以及区块链技术入门详解

    区块链是目前一个比较热门的新概念,蕴含了技术与金融两层概念。从技术角度来看,这是一个牺牲一致性效率且保证最终一致性...

  • 区块链培训之区块链技术汇总

    区块链是目前一个比较热门的新概念,蕴含了技术与金融两层概念。从技术角度来看,这是一个牺牲一致性效率且保证最终一致性...

  • 区块链以及区块链技术入门详解

    区块链是目前一个比较热门的新概念,蕴含了技术与金融两层概念。从技术角度来看,这是一个牺牲一致性效率且保证最终一致性...

  • 区块链的入门到熟悉

    区块链是目前一个比较热门的新概念,蕴含了技术与金融两层概念。从技术角度来看,这是一个牺牲一致性效率且保证最终一致性...

  • 区块链技术在数学积分商城的应用

    区块链是目前一个比较热门的新概念,蕴含了技术与金融两层概念。从技术角度来看,这是一个牺牲一致性效率且保证最终一致性...

  • 同源策略和跨域

    同源策略的目的 保证用户信息的安全 同源的含义 同源指的是:协议相同,域名相同,端口相同注意:www.exampl...

网友评论

      本文标题:实施:同源下发,保证内容一致性 | 技术传播

      本文链接:https://www.haomeiwen.com/subject/icpmnctx.html