基于DITA的NGN核心网文档开发的设计和实现

摘要

技术文档开发和管理在NGN核心网这样的大型软件项目中扮演着重要的角色，需要开发和维护多种类型、数量庞大的技术文档。本文研究的目标是寻找准确、高效、一致地进行技术文档开发，便于统一的、多版本管理，以及很好地支持多语言的方法。XML是理想的文档编写格式，对于信息开发有以下优势：它强调的是内容的结构，而不是形式；可以更好地保持内容的一致性，并更好地保证内容的表现对各种不同输出设备和格式的一致性；它有一个强大的复用模型。DITA是“Darwin Information Typing Architecture”（达尔文信息类型架构）的缩写，它是一个基于XML的体系结构，用于发布技术信息。DITA可以满足NGN核心网文档开发的需求。
　　NGN核心网产品的用户文档包括：技术手册、安装手册、操作手册和维护手册等。每个手册又由一个或几个分册组成。一个分册是一个文档逻辑单元，包含一系列特定的文档。NGN核心网文档的特点是数量多、类型多、更新频率较高、要求规范一致性。使用传统的文档开发和管理方式将面临以下挑战：文档是静态的，基于页面的手册被分开管理，难以查阅；复杂或太多的文字，低质量的和静态的插图，没有动态链接；部件和过程的信息缺失、不准确或过期；服务手册和支持信息所使用的语言不是母语，而本地化成本较高，一致性较差。技术文档的开发涉及大量的文档、多个作者，在文档开发的过程中，不同阶段可能由不同的人负责，需要版本控制工具的支持。传统的文档格式无法很好地支持版本控制工具。技术文档通常要求 HTML格式、PDF等多种格式的输出，需要保持多种输出的一致性。
　　本文通过对DITA深入研究，结合NGN核心网的文档的组成和特点，设计了基于DITA的文档开发解决方案，包括设计规划、文档开发、多版本发布、版本控制、本地化。另外，对技术数据处理的解决方案、通过map实现topic复用进行多版本输出、本地化方案的设计和实施，包括中文字体的处理问题等方面，进行了详细设计和实现。为实际工作中的资料信息开发工作提供了很好的应用案例，有较好的参考价值。

目录

封面

声明

中文摘要

英文摘要

目录

1绪论

1.1 论文的研究背景

1.2 技术文档开发技术的发展和现状

1.3 研究目标和意义

1.4 论文的组织结构

2 DITA的相关技术

2.1 用XML创作的优点

2.2 XML基础

2.3 DITA简介

2.4 使用DITA创作和处理

2.5 DITA-OT

2.6 实施过程

2.7 本章小结

3需求分析与概要设计

3.1 NGN核心网文档的组成和特点

3.2 基于DITA的文档开发解决方案的设计

3.3 本章小结

4详细设计和实现

4.1 针对从数据库导出的信息的解决方案

4.2 通过不同map对topic复用实现同源多版本输出

4.3 本地化解决方案

4.4 本章小结

5方案在实际使用中的问题和对DITA的思考

5.1 方案的初步实施结果

5.2 考虑哪些类型的文档适合使用DITA

5.3 对多人协作的思考

5.4 DITA和DocBook相比的优缺点

5.5 DITA的原则对日常使用Word的启发

5.6 本章小结

6总结和展望

6.1 结论

6.2 展望

参考文献

致谢

作者攻读学位期间发表的论文