Collaborative DITA Documentation for Supporting Software Life Cycle

支持软件生命周期的协作 DITA 文档

• 批准号: 23500127
• 负责人: OKUNO Taku
• 金额: $ 3.16万
• 依托单位: Future University-Hakodate
• 依托单位国家: 日本
• 项目类别: Grant-in-Aid for Scientific Research (C)
• 财政年份: 2011
• 资助国家: 日本
• 起止时间: 2011 至 2013
• 项目状态: 已结题
• 来源: https://kaken.nii.ac.jp/grant/KAKENHI-PROJECT-23500127/
• 关键词: ソフトウェア開発; ドキュメンテーション; トレーサビリティ; XML; DITA; コンテンツマネジメントシステム; RDF; ソフトウェアドキュメンテーション; 再利用性; CMS; ユーザインタフェース; 共通フレーム; 構造化モデル

General software documents have some problems with traceability and maintenance. This study aims to solve those problems by using DITA, an XML-based architecture for authoring technical documents. In DITA architecture, documents consist of topics and maps. Topics have small amount of information that can be reused, and maps specify contents of each output by organizing topics. It helps to browse relative contents together and reuse topics, and then DITA improves document traceability and reduces maintenance costs. For managing software documents as DITA contents, an integrated documentation environment that assists in authoring topics and maps, and other specific works for DITA was developed. As a result of analysis of software documents, it was found that there are three types of structures in software documents, and those need to be broken down into different-sized topics. Besides, the semantic topic search system is realized by using RDF with DITA.

通用软件文档在可追溯性和可维护性方面存在一些问题。本研究的目的是解决这些问题，通过使用DITA，一个基于XML的架构创作技术文档。在DITA体系结构中，文档由主题和映射组成。主题具有少量可重用的信息，映射通过组织主题指定每个输出的内容。它有助于一起浏览相关内容和重用主题，然后DITA提高了文档的可跟踪性并降低了维护成本。为了将软件文档作为DITA内容进行管理，开发了一个集成的文档环境，该环境有助于为DITA创作主题和映射以及其他特定工作。通过对软件文档的分析，发现软件文档中存在三种结构类型，这些结构类型需要分解为不同大小的主题。此外，本文还利用RDF和DITA实现了语义主题检索系统。

项目成果

統合ソフトウェアドキュメンテーション環境としてのDITA ベースCMS の開発

开发基于 DITA 的 CMS 作为集成软件文档环境

• 发表时间: 2013
• 作者: 坂井麻里恵;大場みち子;伊藤恵;奥野拓
• 通讯作者: 奥野拓

DITA を用いたソフトウェアドキュメンテーションにおけるトピックの意味検索手法の提案

基于 DITA 的软件文档主题语义搜索方法的提出

• 发表时间: 2013
• 作者: 坂井麻里恵;大場みち子;伊藤恵;奥野拓
• 通讯作者: 奥野拓

DITAを用いた教育コンテンツ管理手法の検討

基于DITA的教育内容管理方法研究

• 发表时间: 2013
• 作者: 安永 航;大場 みち子;奥野 拓;伊藤 恵;山口 琢;高橋 慈子;関根 哲也
• 通讯作者: 関根 哲也

DITA に基づくソフトウェアドキュメンテーション

基于DITA的软件文档

• 发表时间: 2012
• 作者: 奥野拓;坂井麻里恵;伊藤恵;大場みち子
• 通讯作者: 大場みち子

整合性維持に着目したソースコードとドキュメントの一元管理環境の提案

提出以保持一致性为重点的源代码和文档统一管理环境

• 发表时间: 2013
• 作者: 赤石裕里花;坂井麻里恵;奥野拓;伊藤恵
• 通讯作者: 伊藤恵