用户手册开发标准——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的内容要有完整性