ドキュメント作成システム構築ガイド GitHub、RedPen、Asciidoctor、CIによるモダンライティング Effective Documentation System
出版社名 | 技術評論社 |
---|---|
出版年月 | 2016年4月 |
ISBNコード |
978-4-7741-8036-6
(4-7741-8036-X) |
税込価格 | 2,728円 |
頁数・縦 | 195P 21cm |
商品内容
要旨 |
Gitによるバージョン管理、GitHubを用いた共同編集、RedPenを利用した品質チェック、Travisによる継続的改善、Asciidoctorによる出力。ソフトウェア技法に基づくドキュメント作成の効率化。 |
---|---|
目次 |
第1部 モダンなドキュメント作成(ドキュメンテーション入門 |
おすすめコメント
アプリケーションの開発手順、製品のユーザマニュアルなど、Webで公開されているドキュメントの多くはエンジニアが作成したものです。ドキュメントの品質が低い場合、ユーザ対応に時間を取られるなど、運用がスムーズに進まなくなってしまいます。ドキュメント作成は、エンジニアにとってコーディングと同様避けて通ることはできません。本書は、ソフトウェア開発の技法に基づいてドキュメント作成システムを構築します。Gitを用いたバージョン管理、GitHubによる共同編集、RedPenによる品質チェック、CIツールによる継続的改善などWeb開発で用いられるツールは、ドキュメント作成においても利用できます。応用としてAsciidoctorによるドキュメントのスタイル調整を解説します。Webで公開される公式マニュアルはもちろん、技術文書の電子化にも耐えられる品質を保つことが可能になるでしょう。