KOS-MOS
技術書典7にて頒布した『読みやすい技術書を書く技術』のダウンロード版です。物理本もあるので、ニーズに合うほうを選択できます。 https://booth.pm/ja/items/1311748
概要
本書は、「書く」というプロセスにソフトウェア開発の考え方を導入します。読みやすい文章を執筆するための「環境構築技法」にフォーカスし、継続的に文章を校正する仕組みを整えます。 ちなみに「文章を読みやすくする文章術」については一切出てきません。 対象読者は「読みやすい文章を書きたいエンジニア」です。 技術書のような長い文章を書く人には、特に役立ちます。 また、技術ドキュメントやブログを書く人にも有益です。 詳細については、下記リンクも参考になります。 https://nekopunch.hatenablog.com/entry/2019/09/02/190349 https://nekopunch.hatenablog.com/entry/2019/09/17/091920
なにが書かれているか
校正ツールprh・RedPen・textlintの使い方を学び、これらのツールをCircleCIに組み込みます。CircleCIにはreviewdogを導入し、GitHubに校正ツールの実行結果を通知する仕組みを整えます。さらにRe:VIEWを前提にPDFをCircleCIで自動生成し、PDFのリンクをGitHubへ通知できるようにします。 本書を読めば、校正ツールによるチェックとPDFの生成をすべて、自動実行する環境を構築できるようになります。技術書を書いている人には、わりと最高な感じの環境になります！
目次
1. 出ない神本より出るクソ本 2. Docker 3. Re:VIEW 4. prh 5. RedPen 6. textlint 7. CircleCI 8. reviewdog 9. PDFの自動生成 10. 限界、そしてその先へ
ファイル構成
zipファイルを解凍すると5つのファイルが出てきます。ご自身の環境にあわせて、好きなファイルをご利用ください。 ・ReadableBooks_b5.pdf：紙版と同様のサイズのPDFです ・ReadableBooks_b5_with_cover.pdf：紙版と同様のサイズで表紙と裏表紙付きです ・ReadableBooks_ebook.pdf：小さいサイズのPDFです ・ReadableBooks.epub：epub版です ・ReadableBooks.mobi：Kindleで読めるmobi版です なお、ファイルサイズ軽減のため、最後のひとつを除き、表紙画像は組み込んでいません。壊れているわけではなく仕様となります。