Font Size: a A A

Design And Implementation Of Dita-Based NGN Core Network Documentation Development

Posted on:2012-06-11Degree:MasterType:Thesis
Country:ChinaCandidate:J Y LiFull Text:PDF
GTID:2218330362458828Subject:Software engineering
Abstract/Summary:PDF Full Text Request
Technical documentation development and management plays an important role in large software projects, such as the NGN core network. It is required to develop and maintain a variety of types, a huge number of technical documentation. The goal of this paper is to find accurate, efficient and consistent development method of technical documentation, to facilitate a unified, multi-version management, and a good way to support multiple languages. XML is an ideal format for documentation. It has the following advantages for information development of: it emphasizes the structure of the content, rather than the form; it can keep better consistency of content and guarantee the performance of the content on a variety of different output devices and formats; it has a strong reuse model. DITA is the abbreviation of "Darwin Information Typing Architecture" (Darwin Information Typing Architecture), it is an XML-based architecture for the distribution of technical information.NGN core network products user guides include: technical manuals, installation manuals, operation manuals and maintenance manuals. Each manual is composed of one or several volumes. A volume is a logical document unit that contains a specific set of documents. The characteristic of NGN core network documentation is large quantity, multiple type, high update frequency, requires standardization and consistency. Using traditional document development and management will face the following challenges: documents are static, page-based manuals are managed separately, difficult to access; complex or too much text, and static low-quality illustrations, there is no dynamic link; parts and process information is missing, inaccurate or outdated; service manuals and support information by using a language other than mother tongue, while the localization is high cost and less consistency. Development of technical documentation related to a large number of documents, multiple authors, in the document development process, the different stages may be in charged by different people, version control tools is required. Traditional document format is not well supported version control tool. Technical documentation usually requires HTML, PDF and other formats of output. It is required to maintain the consistency of a variety of output.Based on the research of DITA, combined with the NGN core network documentation composition and characteristics, author designed DITA-based document development solutions, including design, planning, documentation development, multi- release, version control, localization. In addition, author carried out detailed design and implementation in: technical data processing, topics reuse and produce multi version output by map, localization program design and implementation, including handle the problem of Chinese fonts, and so on. It is a good application case for information development in real work. It has a good reference value.
Keywords/Search Tags:XML, information development, DITA, DITA-OT
PDF Full Text Request
Related items