Markdownで執筆をした話

Webアプリエンジニア養成読本 Advent Calendar 2014 - Qiita

これの1日目です。

Webアプリエンジニア養成読本は みんなで「Webアプリエンジニア養成読本」を書きました！ - ゆーすけべー日記 でも書いてある通り、Github上のMarkdownを使って執筆しました。

ここでは、パーフェクトRuby / パーフェクトRuby on Railsを執筆する際はRe:VIEW*1を使っていた、という経験を踏まえた上での所感を書きます。

圧倒的メリット

閲覧がメチャクチャ楽という点に尽きます。とにかく、Github上で原稿を見るというのが非常に楽だし、マークアップも僕らの大好きなGithubフレーバーです。

ちょっとしたデメリット

致命的ではないけれど、以下の点はちょっと気をつける必要があります。

• 注釈やコードブロックなど、書籍用のマークアップはないので表現力に限界があります。そこら辺は編集者さんとの協調を得ながらやっていく必要があります
• 各章への参照*2やリスト番号*3等をいい感じにしてくれるような機構はないため、場合によってはそういうのを手動で頑張る必要があるかもしれない
  • 本書ではそういうのはほとんどなかった

所感

各章が数万文字、かつ各章ごとにほとんど関連がないようなものだと、MarkdownをpushするあるいはMarkdwonエディタで参照すればすぐに完成形が見れるというのはこの上もないメリットです。

執筆当時はなかなか良いMarkdownエディタに巡りあえず苦労しました*4。Markdあたりを使ってましたが、いまならAtomとかが良いんでしょうね、たぶん……。

はい

Webアプリエンジニア養成読本[しくみ、開発、環境構築・運用…全体像を最新知識で最初から! ] (Software Design plus)

よろしくお願いいたします

*1:https://github.com/kmuto/review

*2:X章 xxxxみたいなヤツ

*3:リスト 2.10みたいなヤツ

*4:Mowとかでは文字数が多すぎてまったく役に立たない