by shigemk2

当面は技術的なことしか書かない

memo 反面教師で学ぶ参考書の書き方 #kbkz_tech

https://ezoeryou.github.io/how-not-to-write-textbook/

@ezoeryou

ソースファイルは分割しろ

  • xhtmlが未来だった時代
    • でもそうならなかった
    • 1MB以上あった手書きのXHTMLファイル
    • Vimで開いてもなおしんどい
  • ウェブブラウザ上で編集ができなくなった(ファイルサイズがでかすぎて 1MB以上)
    • Gitを知らないとプルリクが投げられない

テストを書け

  • 参考書のサンプルコードの数割がコンパイル通らない
    • typo/セミコロン抜けている などが大半
    • 2009年のコードだから古い

技術革新を怠るな

  • 1文字は1バイト
  • C++のlocaleで国際化対応できる
  • C++の正規表現ライブラリは国際化対応
  • 最新のC++規格知識の欠如

  • マークダウンでファイル分割

  • pandocでフォーマット変換
  • Makeでビルド
  • gitで管理
  • GitHubで共同編集

  • サンプルコードをテストしたけどコンパイルできない

    • textlintを使ったが偽陽性が多い
  • xkcd
  • マニュアルの読み方から始まるマニュアルはだいたい良くない
  • reveal.jsでスライドにしている