用户手册开发标准——DITA
DITA Standard
1 DITA 全称是：Darwin Information Typing Architecture
2 IBM定义的一个标准
3 DITA定义了XML文档的写作要求 包含topic类型、topic元素、手册架构等
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
机房管理员
岗位职责
1
日例行检查
…
2
处理一般告警
…
3
报告严重故障
…
阅读手册
例行维护指导
1
…
操作指导
2
…
告警参考 3
用户手册读者——维护工程师
维护工程师
工作职责
1
软硬件维护
…
2
告警处理，定位及处理故障…
3 处理或者协助设备提供商处理紧急故障
阅读手册
操作指导… 1
性能计数器参考 2
性能指标参考
3
•…
告警参考
文档专家审核
技术专家审核&实验室测试
试验局验证
发布
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
文档开发部组织架构
部长
深圳/北京等地
副部长
南京/上海等地
多
媒
C
体
D
&
M
M
A
M
无
监
线
测
传 输 及 动 力
❖ Topic
Topic是写作和重用的基本单元 Topic的内容要有独立性 Topic的内容要有完整性
❖ PUBMAP
PUBMAP指定了在最终输出物中Topic组装的顺序和相互关系 PUBMAP由架构师基于客户对手册的要求设计
3 标准的文档体系（遵循GR454标准）
1,2必须通过有效手段传递到文档开发部
2-开发
作为研发组中的文档组，开发任务来自研发代表 1
分析需求，制作架构，制定计划 2
研发素材来自上游 3
研发、售后、规划多方参与审核、测试 4
英文输出由学院英语支持部负责。小语种开发由代表处负责。
问题处理流程
3-质量控制
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
用户手册开发平台架构
XML内容编制
XML Editor XML Editor
XML Editor
Check in/out
集中内容管理
Content Manager Systerm
版本控制
检入检出 控制
链接管理
文档结构 管理
权限管理 可重用单 元管理 工作流程
电子文件（文档和光盘） 3
第3项，由项目灵活选择交付形式
5-反馈
（)
用户手册开发流程
PDT
下达任务 及反馈文 档需求
审核文 档架构
产品线 提供研 发素材
架构师
开发/翻译
架构师
制图
说明及参考型文档
产品专家 程序型文档
文档测试员
客户专家
需求分析 及架构开发
编写
Байду номын сангаас
用户手册读者
手册读者
用户手册读者——规划工程师
规划工程师
岗位职责
1
网络设计
•…
2
• …系统配置
3
• …性能评估和优化
阅读手册
产品描述… 1
硬件描述… 2
性能计数器参考 3
性能指标参考
4
•…
用户手册读者——安装督导
岗位职责
1
指导设备安装人员安装硬件设备
•…
2
• …确保安装质量
3
阅读手册
安装督导
硬件描述… 1
4
•…
故障处理
5
•…
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
用户手册开发的5个环节
文档需求
文档发布
需求
• Text
反馈
发布
开发 审核&测试
1-需求
合同中的文档条款 1
客户随需求谈判/工程执行提出的文档需求 2
软件安装 硬件安装 数据配置 产品描述 硬件描述 系统描述
故障处理类手册
操作维护类手册
安装配置类手册 技术描述类手册
通用命令参考 性能指标参考 性能计数器参考
提示: 产品不同，架构可能会有不同
RNC用户手册架构
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
ZTE用户手册体系介绍
中兴通讯学院 文档开发部
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
用户手册组成
技术描述 安装配置
操作维护 故障处理 参考
用户手册组成
告警参考 故障处理 应急维护
操作指导 例行维护
&
ICT
TD &LT E& 微 波 & RFI D
核 心 网 CS/ PS/ HLR
IMS & NG N & EM S
固 网
GU
数 据
业 务
手 机
工具/架构/外包/培训平台
用户手册开发架构
研发代表
IA(架构师)
文档测试
DE
(文档工程师)
翻译
制图
信息管理
用户手册体系介绍
1 手册组成 2 手册读者 3 手册开发流程 4 手册开发架构
5 手册开发标准 6 手册开发平台 7 获取手册 8 大国大T支持
用户手册开发标准
1
基于GR454的文档架构
2
基于XML的DITA标准
用户手册开发标准——GR454
GR454-CORE
1 Telecode于1997年发布的
2 它对供应商提供的文档提出了通用需求
3 它覆盖了文档开发的全流程 包含文档开发准备、开发要求、架构评审、信息的发布评 估和升级等内容。
评审研发素材 文档专家审核 产品专家审核
实验室测试 试验局验证
高质量文档
如果项目成立了文档团队，前方参与语言审核更为有效。
4-发布
PDF格式（印刷/电子文件/光盘/网站） 1 HTML格式（光盘/电子光盘）
不能发布Word格式 2
随设备发放印刷品/光盘 1
Support网站（外部） 2 TSM网站（内部）
2
硬件安装指导…
用户手册读者——设备安装工程师 设备安装工程师 岗位职责
1
硬件安装
•…
阅读手册
1
硬件安装指导…
用户手册读者——调试工程师
调试工程师
岗位职责
1
调试
…
2
系统功能测试
…
3
割接
…
4
扩容
…
5
升级
…
阅读手册
产品描述… 1
硬件描述… 2
软件安装指导 3
数据配置指导
4
•…
用户手册读者——机房管理员
生命周期
DB
统一发布平台
Publishing Engine
文档拆分/ 合并规则 文档比较
Profiling
Styler
Print/ PDF
WEB
用户手册开发的几个概念
❖ DOCMAP
DOCMAP规定了一整套文档的架构 DOCMAP由架构师基于GR454的主题区和子集进行设计 DOCMAP定义了在这套文档中要包括的Topic信息