弊社では毎週木曜日にもくもく会を開催しています。
今回は昨日 1/24 のもくもく会での成果を紹介します。
背景
2019 年の目標の一つ（他の目標あとで書くかも）に「技術書執筆」を掲げており、どうやって書いていけばいいのかなーと悩んでいた折、ちょうど知り合いでコミュニティマネージャーをやっている さのし のツイートを見かけました。
なんとなく技術書は書いてみたいけど、どうやったらいいかわからないとか、できれば誰かの企画に乗っかりたいとか、そういう人いたら私までDMをplease
— さのし@表参道女子 (@sano_shoichi) 2019年1月8日
さっそく連絡を取り、サークルの合同誌に参加させてもらうことになりました。
執筆作業には Re:VIEW を使うので、自分の作業環境構築および Re:VIEW の勉強を兼ねて Docker + Docker Compose で動かせる環境を作ってみました。
成果物
使い方は readme.md に書いてあるとおり。
Docker + Docker Compose がインストールされている環境であれば、これで PDF の生成や textlint の実行をすることができます。
textlint は構文・文法のチェックをしてくれます。
例えば次のように句点（。）が連続している場合
= テスト 私はおかしょいと申します。。
% make lint docker-compose run --rm textlint make lint npx textlint ./index.re /workdir/index.re 3:14 error "。" が連続して2回使われています。 preset-ja-technical-writing/ja-no-successive-word ✖ 1 problem (1 error, 0 warnings)
このようにエラーとして検出してくれます。
他にどのような誤りを検出してくれるのかはまだ検証していませんが、とても心強い味方になってくれそうです。
初めての技術書執筆、頑張りたいと思います！
