ドキュメント作成システム構築ガイド
[GitHub,RedPen,Asciidoctor,CIによる モダンライティング]
2016年3月25日紙版発売
2016年3月25日電子版発売
伊藤敬彦,吉村孝広 著
A5判/208ページ
定価2,728円(本体2,480円+税10%)
ISBN 978-4-7741-8036-6
ただいま弊社在庫はございません。
書籍の概要
この本の概要
アプリケーションの開発手順,製品のユーザマニュアルなど,ドキュメントの多くはエンジニアによって作成されています。ドキュメントの品質が低い場合,読み手が誰であっても内容の理解に時間がかかります。ドキュメントは簡潔で内容を正確に伝えるものでなければなりません。
エンジニアにとってドキュメント作成は避けて通れません。いまやドキュメント作成はコーディングと同様にエンジニアに必要な技術なのです。本書は,ソフトウェア開発の技法に基づいてドキュメント作成を支援するシステムを構築します。このシステムではGitを用いたバージョン管理,GitHubによる共同編集,RedPenによる品質チェック,CIツールによる継続的改善などを利用します。
応用としてAsciidoctorによるドキュメントのスタイル調整について解説します。Webでの公開に耐える品質はもちろん,技術文書の電子出版においても役立つ内容となっています。
こんな方におすすめ
- Webサービス開発者,技術文書を公開したいと考えているエンジニア
この書籍に関連する記事があります!
- エンジニアにとっての技術文書
- エンジニアが成果物を作るたびに,成果物を解説する技術文書が必要になります。
この本に関連する書籍
-
Slack入門 [ChatOpsによるチーム開発の効率化]
いま最も注目を集めるチャットコミュニケーションツールSlackの解説書です。 Slackが人気の背景には,さまざまなサービスと連携してソフトウェア開発を効率化できる...
-
<文章嫌いではすまされない!> エンジニアのための 伝わる書き方講座
文書作成でお悩みですか? ビジネスで使う文書を作るのに,文筆家が書くような「うまい文章」の書き方を修得する必要はありません。エンジニアに必要なのは,難しくな...
-
チーム開発実践入門──共同作業を円滑に行うツール・メソッド
本書はサービスやアプリケーションを開発する企業において,複数の人たちでチームを組んで開発を進めていく際に必要な考え方や使用するツール,またそれらをうまく使い...
-
GitHub実践入門──Pull Requestによる開発の変革
GitHubの実践的な使い方を,実際に手を動かす形で解説する書籍です。初学者の方にもわかりやすいよう,基本的なGitやGitHubの使い方から,「ソーシャルコーディング」の...