ドキュメント作成システム構築ガイド[GitHub，RedPen，Asciidoctor，CIによる モダンライティング]
この本の概要 アプリケーションの開発手順，製品のユーザマニュアルなど，ドキュメントの多くはエンジニアによって作成されています。ドキュメントの品質が低い場合，読み手が誰であっても内容の理解に時間がかかります。ドキュメントは簡潔で内容を正確に伝えるものでなければなりません。 エンジニアにとってドキュメント作成は避けて通れません。いまやドキュメント作成はコーディングと同様にエンジニアに必要な技術なのです。本書は，ソフトウェア開発の技法に基づいてドキュメント作成を支援するシステムを構築します。このシステムではGitを用いたバージョン管理，GitHubによる共同編集，RedPenによる品質チェック，CIツールによる継続的改善などを利用します。 応用としてAsciidoctorによるドキュメントのスタイル調整について解説します。Webでの公開に耐える品質はもちろん，技術文書の電子出版においても役立つ内
![ドキュメント作成システム構築ガイド[GitHub，RedPen，Asciidoctor，CIによる モダンライティング]](https://cdn-ak-scissors.b.st-hatena.com/image/square/1f842fbac91c19dd5e4a093e5e962d20ea9abb1e/height=288;version=1;width=512/https%3A%2F%2Fgihyo.jp%2Fassets%2Fimages%2Fcover%2F2016%2Fthumb%2FTH800_9784774180366.jpg)
技術ドキュメントにもCIを~「ドキュメント作成システム構築ガイド」を読んで ~ - Qiita
ドキュメント作成システム構築ガイド を読み終えたので、その感想です。GitHubとCIサービスの組み合わせ方、gitやmarkdownの初歩的な使い方も丁寧に書かれているので、意外と新人向きの書籍かもしれません。 発売前に、エクセルで手順書を作るのはきっとやめた方がいいという自分の投稿に、その解決策としてCIに沿ったライティングの情報を追加したのですが、それが著者のお一人の目に留まったらしく、なんだか恐縮です。 概要 ソースコードの品質を高めるために、継続的インテグレーション(CI)が導入されてきたように、ドキュメントに対してもそれをやろうというものです。そのために バージョン管理システム(Git) Gitで差分が見やすい軽量マークアップ言語(markdown,asciidocなど) 文章を校正するためのツール(RedPen,textlintなど) PDFやHTMLなどに出力するためのツー
【Marxico】EvernoteユーザーのためのMarkdownエディター - 段ボール箱の中身 Chrome
Evernoteは手放せないほど重要なツールですが、エディターの使い勝手には不満を持っています。文章を入力するには必要十分ですが、細かなことろで色々と、、、です。いちばん不満なのはHTMLやMarkdownで入力ができないこと。HTMLの直接入力はできなくとも、Markdownでの入力はサポートしてほしいと思っていました。 EvernoteとMarkdownが大好きなあなたにMarxicoはオススメなエディターです。 MarxicoはMarkdown記法をサポートし、Evernoteに直接保存することができる無料のエディターです。Chromeの拡張機能ですので、Chromeがインストールされている環境であれば、簡単に利用を開始することができます。Markdown記法のサポートの他にも独自の入力方式を持っています。Markdownだけでは表現できないテーブルや数式などの入力も可能です。 Ma
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
