DevOps

用户为中心

协同共创

持续演进

敏捷文档交付中兴通讯

作者：张佑文金泽锋叶文华

目录

01 02 03 04

敏捷文档交付 文档DevOps 收益成效 思考展望

01

敏捷文档交付

文档交付的痛点

l 发布滞后

l 反馈周期长l 重复编写

版本开发周期

延迟

…

需求 设计 实现 验证规划 需求 设计 实现 验证规划

传统研发模式的文档交付

文档交付的痛点

l 素材减少

l 滞后频繁l 内容碎片化

版本开发周期 发布节奏

延迟

… 延迟

敏捷研发模式的文档交付

文档解决方案-DITA

l 模块化协作、同源重用

l 流程弱关联l 专业写作者

文档解决方案-DITA

l 模块化协作、同源重用

l 流程弱关联l 专业写作者

文档解决方案-开源代码化

sphinx

l 研发人员写作

l 流程、工具、管理的代码化

现有方案效果

文档交付痛点 DITA方案 开源代码化方案

发布滞后，频繁出现 NA

重复编写

反馈周期长 NA

素材减少 NA

内容碎片化

敏捷软件交付

云测试

需求&任务 团队协作 代码开发 代码检查 持续集成 自动化测试 打包发布 自动部署

Confuence Gerrit Artifactory 云部署JIRA Fortify 云CI

Blackduck 自研SWRKlocwork Jenkins

Nessus

TFS

Coverity Docker绿盟

Mesos

Jenkins

持续规划 协作开发 持续测试 发布与部署

WebInspect

Support

Web IDE

软件DevOps平台

敏捷文档交付

共创生产 自动构建 发布部署 反馈闭环

文档DevOps平台

采集器 发布引擎

同源规划 多格式输入 内容检查 持续集成 灵活发布 快速反馈

在线反馈版本管理领域模型库

协同写作

文档CI

Gerrit Jekins

Docker

Mesos

Confluence

LeanDoc

WPS

Word

闭环管理

有效闭环

Artifactory

Support

02

文档DevOps

文档Devops目标与愿景

n 愿景n 用户为中心，协同高效，持续演进的产品知识服务平台

n 持续提升用户满意度，提升知识的利用率，激发产品的创新，实现知识价值最大化

n 目标n 支撑用户：客户、工服、售前、研发各类用户的文档交付

n 典型特征：文档与产品同步交付、同源交付、按需交付、迭代交付

n 预期效果：助力提升文档的准确性、及时性、完整性、可用性

文档Devops模型

领域模型

信息流

应用层

售前 工服 客户

特性 场景 产品版本需求 方案

高层访谈

HLD

引导标书

基准胶片

升级指导

测试验收

版本说明

网优方案

FD/FG

命令手册

参数手册

北向接口 API手册

SDK手册

研发

模板通过模板表达领域模型，高内聚低耦合，并适配规范

配置按产品，通过配置定义模板间关系，表达交付文档的架构和信息流

产品1 产品2 产品xxx

文档DevOps

样式按照用户叠加统一样式，确保用户体验

文档Devops流程

售前

工服

客户

特性

故障

模型库

代码

需求

方案

FL/FD

HLD

升级指导

版本说明

FD/FG

参数手册

API手册 研发

标准化 体系化 定制化自动化组件化

生产 构建 发布

研发

工服

规划

翻译

可视化团队协同 用户体验

反馈

代码化

文档

快速反馈快速闭环

①

④

③②

领域模型库：内容同源基础

两端多样化：多种格式支持内容生产格式 版本号 适用领域Wiki confluence 6.2.1 大型团队信息知识分享

RST PEP 287 开源领域技术文档编写

WORD word97及以上 通用办公文档编写

MarkDown 1.0.1 开源领域技术文档编写

DITA 1.0/1.1/1.2/1.3 专业文档印刷出版行业

HTML 2.0/3.2/4.0/4.01/5.0/5.1 在线网络内容展示

文档发布格式 版本号 应用场景自有格式文档包 ZED 企业专用文档包及阅读器

HTML 2.0/3.2/4.0/4.01/5.0/5.1 超文本网页，在线发布的通用格式

Pdf ISO 32000-1 ISO 32000-2

跨平台发布文档通用格式

Word word97及以上 通用办公，通用文档发布

Excel excel97及以上 通用办公，通用文档发布

CHM 1.0/1.1a/1.3/1.32/1.33/1.4 windows常用帮助

03

收益成效

方案优势对比

文档交付痛点 DITA 开源代码化 文档DevOps 特点

发布滞后，频繁出现 NA • 文档融入迭代交付流程

重复编写 • 同源规划设计• 组件化标准化• 专家直接编写

反馈周期长 NA • 持续集成• 减少抛接

素材减少 NA • 领域模型库

内容碎片化 • 全员协同写作

方案对文档的影响

环节 特点 准确性 完整性 及时性 可用性

生产

全流程 √ √

全员协同 √ √ √

组件化标准化 √

构建

代码化 √

自动化 √ √

可视化 √ √

发布

体系化 √

定制化 √

用户体验 √

反馈快速反馈 √ √

快速闭环 √ √

实施成效

特性指导书生产环节 构建发布环节

实施前 实施后 效果 实施前 实施后 效果

时长（小时） 58 40 缩短31% 1 0.04 缩短96%

人力投入（人时） 64 36 减少44% 1 0 不需要人力

版本发布说明书生产环节 构建发布环节

实施前 实施后 效果 实施前 实施后 效果

人力投入（人时） 32 8 减少75% 1 0 不需要人力

l 周期成本降低

实施成效

l 及时性显著提高

• 实施之前，文档滞后平均2个月以上，缩短到当前平均2天左右

l 文档质量提高

• 一致性、准确性、完整性明显增强，三类问题下降70%以上

l 可用性待确认

• 待进一步收集外部用户反馈

04

思考展望

文档DevOps思考

n 实施要求

① 敏捷开发下写必要的文档

② 站在用户的角度编写内容

③ 内容解耦和标准化

n 实施制约

① 有敏捷和DevOps基础

② 同源设计信息架构搭建的投入产出

文档DevOps展望

DevOps

用户为中心

协同共创

持续演进

谢谢THANKS