ドキュメントを直し続ける話 #kbkz_tech

ドキュメントを直し続ける話

歌舞伎座.tech #14 2017/11/18 shigemk2

自己紹介

● shigemk2● アドテクエンジニア● ScalaとかHadoopとかReactとか● http://www.shigemk2.com/

今日はOSSのドキュメントに貢献し続ける

話をします

巷でよく言われる話

ドキュメント修正もOSS貢献

では何をするか

● typo● リンク切れ● リンク先の変更

● rundeck(pandoc)● fish-shell(doxygen)● ansible(sphinx)● aws-cli(sphinx)

１つ１つはたぶん簡単

でも直し続けるのは難しいと思う

どう直すの？

IDEの、typoを直す機能

delete-trailing-whitespace

delete-trailing-whitespace

雑なサイクル1. IntelliJ(とかのJB系IDE)でファイルを開く2. F2キーでtypoに飛ぶ3. 目視してtypoかどうか見る4. typoだったらctrl + Enterで直す5. リンクを開いてリダイレクトされたら直す6. Emacsのdelete-trailing-whitespace7. 1ページにつき1プルリク8. 1-7を延々と毎日繰り返す

どう続けるの？

ドキュメントを更新し続けるのは難しい

可視化されてるからたぶんがんばれる

おわり