Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

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

1,076 views

Published on

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

Published in: Technology
  • Be the first to comment

  • Be the first to like this

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

  1. 1. ドキュメントを直し続ける話 歌舞伎座.tech #14 2017/11/18 shigemk2
  2. 2. 自己紹介 ● shigemk2 ● アドテクエンジニア ● ScalaとかHadoopとかReactとか ● http://www.shigemk2.com/
  3. 3. 今日はOSSの ドキュメントに貢献し続ける 話をします
  4. 4. 巷でよく言われる話
  5. 5. ドキュメント修正も OSS貢献
  6. 6. では何をするか
  7. 7. ● typo ● リンク切れ ● リンク先の変更
  8. 8. ● rundeck(pandoc) ● fish-shell(doxygen) ● ansible(sphinx) ● aws-cli(sphinx)
  9. 9. 1つ1つはたぶん簡単
  10. 10. でも直し続けるのは 難しいと思う
  11. 11. どう直すの?
  12. 12. IDEの、typoを直す機能
  13. 13. delete-trailing-whitespace
  14. 14. delete-trailing-whitespace
  15. 15. 雑なサイクル 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を延々と毎日繰り返す
  16. 16. どう続けるの?
  17. 17. ドキュメントを 更新し続けるのは難しい
  18. 18. 可視化されてるから たぶんがんばれる
  19. 19. おわり

×