OSSドキュメンテーション勉強会のLT資料です。 https://kbkz.connpass.com/event/5150/

1. ドキュメントを直し続ける話
歌舞伎座.tech #14 2017/11/18 shigemk2

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

3. 今日はOSSの
ドキュメントに貢献し続ける
話をします

4. 巷でよく言われる話

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

6. では何をするか

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

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

12. １つ１つはたぶん簡単

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

15. どう直すの？

17. IDEの、typoを直す機能

18. delete-trailing-whitespace

19. delete-trailing-whitespace

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

21. どう続けるの？

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

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

24. おわり