ドキュメント作成システム構築ガイド [GitHub，RedPen，Asciidoctor，CIによる モダンライティング]

この本の概要

アプリケーションの開発手順，製品のユーザマニュアルなど，ドキュメントの多くはエンジニアによって作成されています。ドキュメントの品質が低い場合，読み手が誰であっても内容の理解に時間がかかります。ドキュメントは簡潔で内容を正確に伝えるものでなければなりません。
エンジニアにとってドキュメント作成は避けて通れません。いまやドキュメント作成はコーディングと同様にエンジニアに必要な技術なのです。本書は，ソフトウェア開発の技法に基づいてドキュメント作成を支援するシステムを構築します。このシステムではGitを用いたバージョン管理，GitHubによる共同編集，RedPenによる品質チェック，CIツールによる継続的改善などを利用します。
応用としてAsciidoctorによるドキュメントのスタイル調整について解説します。Webでの公開に耐える品質はもちろん，技術文書の電子出版においても役立つ内容となっています。

こんな方におすすめ

• Webサービス開発者，技術文書を公開したいと考えているエンジニア

目次

第1部 モダンなドキュメント作成
第1章 ドキュメンテーション入門

• 1.1 ドキュメントの種類
• 1.2 ドキュメントの品質
• 1.3 オープンソース化するドキュメント
• 1.4 ドキュメントを作成する際の注意点
• 1.5 規約に基づいたドキュメント作成
• 1.6 共同作業による効率アップと問題点
• 1.7 継続的インテグレーション
• 1.8 ドキュメント作成でも継続的インテグレーション
• 1.9 まとめ

第2章 利用するツールの準備

• 2.1 利用するツールの概要
• 2.2 バージョン管理システム
• 2.3 ドキュメント検査ツール
• 2.4 継続的インテグレーションツール
• 2.5 エディタ
• 2.6 まとめ

他