Submit Search
Upload
ドキュメントを直し続ける話 #kbkz_tech
•
0 likes
•
1,404 views
Michihito Shigemura
Follow
OSSドキュメンテーション勉強会のLT資料です。 https://kbkz.connpass.com/event/5150/
Read less
Read more
Technology
Report
Share
Report
Share
1 of 24
Download now
Download to read offline
Recommended
Ansibleに貢献してみよう
Ansibleに貢献してみよう
Michihito Shigemura
オンプレエンジニアがクラウドエンジニアを夢見て。じっと手を見る。
オンプレエンジニアがクラウドエンジニアを夢見て。じっと手を見る。
Akihiro Kuwano
Pyramid + socket.io 人狼を作ってみた
Pyramid + socket.io 人狼を作ってみた
Junya Hayashi
泥臭い運用から、プログラマブルインフラ構築(に行きたい)
泥臭い運用から、プログラマブルインフラ構築(に行きたい)
Akihiro Kuwano
ホームディレクトリに埋もれた便利なコードをさがせ!
ホームディレクトリに埋もれた便利なコードをさがせ!
Yohei Fushii
Python におけるドメイン駆動設計(戦術面)の勘どころ
Python におけるドメイン駆動設計(戦術面)の勘どころ
Junya Hayashi
js-ctypes - ネイティブコードを呼び出す新しいカタチ
js-ctypes - ネイティブコードを呼び出す新しいカタチ
Makoto Kato
Ohotech特盛 #11 Box2DWebを触ってみよう
Ohotech特盛 #11 Box2DWebを触ってみよう
Fumihito Yokoyama
Recommended
Ansibleに貢献してみよう
Ansibleに貢献してみよう
Michihito Shigemura
オンプレエンジニアがクラウドエンジニアを夢見て。じっと手を見る。
オンプレエンジニアがクラウドエンジニアを夢見て。じっと手を見る。
Akihiro Kuwano
Pyramid + socket.io 人狼を作ってみた
Pyramid + socket.io 人狼を作ってみた
Junya Hayashi
泥臭い運用から、プログラマブルインフラ構築(に行きたい)
泥臭い運用から、プログラマブルインフラ構築(に行きたい)
Akihiro Kuwano
ホームディレクトリに埋もれた便利なコードをさがせ!
ホームディレクトリに埋もれた便利なコードをさがせ!
Yohei Fushii
Python におけるドメイン駆動設計(戦術面)の勘どころ
Python におけるドメイン駆動設計(戦術面)の勘どころ
Junya Hayashi
js-ctypes - ネイティブコードを呼び出す新しいカタチ
js-ctypes - ネイティブコードを呼び出す新しいカタチ
Makoto Kato
Ohotech特盛 #11 Box2DWebを触ってみよう
Ohotech特盛 #11 Box2DWebを触ってみよう
Fumihito Yokoyama
hooks riverpod + state notifier + freezed でのドメイン駆動設計
hooks riverpod + state notifier + freezed でのドメイン駆動設計
Shinnosuke Tokuda
Idcfクラウド 初心者の事始め(2)資料
Idcfクラウド 初心者の事始め(2)資料
Takako Miyagawa
Riverpodでテストを書こう
Riverpodでテストを書こう
Shinnosuke Tokuda
新しい EditorConfig (IntelliCode)
新しい EditorConfig (IntelliCode)
m ishizaki
Gentoo勉強会平成26/7月/5日
Gentoo勉強会平成26/7月/5日
alice ferrazzi
ROS2.0時代に備えたc++11/14
ROS2.0時代に備えたc++11/14
Takashi Ogura
Pythonで画面付きのアプリを作成する
Pythonで画面付きのアプリを作成する
Jun Okazaki
Rustのテストやエコシステム
Rustのテストやエコシステム
KiyotomoHiroyasu
LT#7 Hello coffeeしてきた
LT#7 Hello coffeeしてきた
Shingo Inoue
映画にでてくるハッカーになりたい - YAPC Asia 2010
映画にでてくるハッカーになりたい - YAPC Asia 2010
Hiroh Satoh
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Kohei Asai
Botkit4.x Has Come!
Botkit4.x Has Come!
Hikaru Uchiyama
SPA×Auth0
SPA×Auth0
春奈 岡
AmazonElasticBeanstalk
AmazonElasticBeanstalk
Taisuke Oe
node-gypを使ったネイティブモジュールの作成
node-gypを使ったネイティブモジュールの作成
shigeki_ohtsu
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
Hiroh Satoh
JSDoc ToolKit
JSDoc ToolKit
Ryo Maruyama
テストコードをアプリケーションコードと同じ階層に置きたい
テストコードをアプリケーションコードと同じ階層に置きたい
Hiroshi Kikuchi
delayed_jobの自動再起動
delayed_jobの自動再起動
firewood
20121115 fukuoka sublime0_kuroneko
20121115 fukuoka sublime0_kuroneko
Kohki Nakashima
Redmine4時代のプラグイン開発 redmine.tokyo #13
Redmine4時代のプラグイン開発 redmine.tokyo #13
Sho Douhashi
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
Koichiro Matsuoka
More Related Content
What's hot
hooks riverpod + state notifier + freezed でのドメイン駆動設計
hooks riverpod + state notifier + freezed でのドメイン駆動設計
Shinnosuke Tokuda
Idcfクラウド 初心者の事始め(2)資料
Idcfクラウド 初心者の事始め(2)資料
Takako Miyagawa
Riverpodでテストを書こう
Riverpodでテストを書こう
Shinnosuke Tokuda
新しい EditorConfig (IntelliCode)
新しい EditorConfig (IntelliCode)
m ishizaki
Gentoo勉強会平成26/7月/5日
Gentoo勉強会平成26/7月/5日
alice ferrazzi
ROS2.0時代に備えたc++11/14
ROS2.0時代に備えたc++11/14
Takashi Ogura
Pythonで画面付きのアプリを作成する
Pythonで画面付きのアプリを作成する
Jun Okazaki
Rustのテストやエコシステム
Rustのテストやエコシステム
KiyotomoHiroyasu
LT#7 Hello coffeeしてきた
LT#7 Hello coffeeしてきた
Shingo Inoue
映画にでてくるハッカーになりたい - YAPC Asia 2010
映画にでてくるハッカーになりたい - YAPC Asia 2010
Hiroh Satoh
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Kohei Asai
Botkit4.x Has Come!
Botkit4.x Has Come!
Hikaru Uchiyama
SPA×Auth0
SPA×Auth0
春奈 岡
AmazonElasticBeanstalk
AmazonElasticBeanstalk
Taisuke Oe
node-gypを使ったネイティブモジュールの作成
node-gypを使ったネイティブモジュールの作成
shigeki_ohtsu
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
Hiroh Satoh
JSDoc ToolKit
JSDoc ToolKit
Ryo Maruyama
テストコードをアプリケーションコードと同じ階層に置きたい
テストコードをアプリケーションコードと同じ階層に置きたい
Hiroshi Kikuchi
delayed_jobの自動再起動
delayed_jobの自動再起動
firewood
20121115 fukuoka sublime0_kuroneko
20121115 fukuoka sublime0_kuroneko
Kohki Nakashima
What's hot
(20)
hooks riverpod + state notifier + freezed でのドメイン駆動設計
hooks riverpod + state notifier + freezed でのドメイン駆動設計
Idcfクラウド 初心者の事始め(2)資料
Idcfクラウド 初心者の事始め(2)資料
Riverpodでテストを書こう
Riverpodでテストを書こう
新しい EditorConfig (IntelliCode)
新しい EditorConfig (IntelliCode)
Gentoo勉強会平成26/7月/5日
Gentoo勉強会平成26/7月/5日
ROS2.0時代に備えたc++11/14
ROS2.0時代に備えたc++11/14
Pythonで画面付きのアプリを作成する
Pythonで画面付きのアプリを作成する
Rustのテストやエコシステム
Rustのテストやエコシステム
LT#7 Hello coffeeしてきた
LT#7 Hello coffeeしてきた
映画にでてくるハッカーになりたい - YAPC Asia 2010
映画にでてくるハッカーになりたい - YAPC Asia 2010
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Nodeとフロントエンド − 知っておかなければならない、今と未来の話 −
Botkit4.x Has Come!
Botkit4.x Has Come!
SPA×Auth0
SPA×Auth0
AmazonElasticBeanstalk
AmazonElasticBeanstalk
node-gypを使ったネイティブモジュールの作成
node-gypを使ったネイティブモジュールの作成
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
ぼくのかんがえたさいきょうのうぇぶあぷりけーしょんふれーむわーく - YAPC Asia 2011
JSDoc ToolKit
JSDoc ToolKit
テストコードをアプリケーションコードと同じ階層に置きたい
テストコードをアプリケーションコードと同じ階層に置きたい
delayed_jobの自動再起動
delayed_jobの自動再起動
20121115 fukuoka sublime0_kuroneko
20121115 fukuoka sublime0_kuroneko
Viewers also liked
Redmine4時代のプラグイン開発 redmine.tokyo #13
Redmine4時代のプラグイン開発 redmine.tokyo #13
Sho Douhashi
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
Koichiro Matsuoka
Java SE 9の紹介: モジュール・システムを中心に
Java SE 9の紹介: モジュール・システムを中心に
Taku Miyakawa
cpprefjp documentation
cpprefjp documentation
Akira Takahashi
ユニットテストのアサーション 流れるようなインターフェースのAssertJを添えて 入門者仕立て
ユニットテストのアサーション 流れるようなインターフェースのAssertJを添えて 入門者仕立て
Ryosuke Uchitate
劇的改善 Ci4時間から5分へ〜私がやった10のこと〜
劇的改善 Ci4時間から5分へ〜私がやった10のこと〜
aha_oretama
Spring Bootの本当の理解ポイント #jjug
Spring Bootの本当の理解ポイント #jjug
Masatoshi Tada
ICTSC5 大人達の戦い LT資料
ICTSC5 大人達の戦い LT資料
Ken SASAKI
C++1z draft
C++1z draft
Akira Takahashi
ユニキャスト本社のネットを支える技術
ユニキャスト本社のネットを支える技術
Wataru NOGUCHI
Oss貢献超入門
Oss貢献超入門
Michihito Shigemura
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:前半
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:前半
Management_CoLtd
MyBatis を利用した web application 開発についてのご紹介
MyBatis を利用した web application 開発についてのご紹介
Tokuhiro Matsuno
Oracle対応アプリケーションのDockerize事始め
Oracle対応アプリケーションのDockerize事始め
Satoshi Nagayasu
はじめてのDockerパーフェクトガイド(2017年版)
はじめてのDockerパーフェクトガイド(2017年版)
Hiroshi Hayakawa
失敗と向き合う姿勢を正す話
失敗と向き合う姿勢を正す話
LIFULL Co., Ltd.
GitLabを16万8千光年ワープさせた話(改)
GitLabを16万8千光年ワープさせた話(改)
Wataru NOGUCHI
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:後半
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:後半
Management_CoLtd
失敗事例で学ぶ負荷試験
失敗事例で学ぶ負荷試験
樽八 仲川
メルカリ カウルのマスタデータの更新
メルカリ カウルのマスタデータの更新
Takuya Ueda
Viewers also liked
(20)
Redmine4時代のプラグイン開発 redmine.tokyo #13
Redmine4時代のプラグイン開発 redmine.tokyo #13
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
Java SE 9の紹介: モジュール・システムを中心に
Java SE 9の紹介: モジュール・システムを中心に
cpprefjp documentation
cpprefjp documentation
ユニットテストのアサーション 流れるようなインターフェースのAssertJを添えて 入門者仕立て
ユニットテストのアサーション 流れるようなインターフェースのAssertJを添えて 入門者仕立て
劇的改善 Ci4時間から5分へ〜私がやった10のこと〜
劇的改善 Ci4時間から5分へ〜私がやった10のこと〜
Spring Bootの本当の理解ポイント #jjug
Spring Bootの本当の理解ポイント #jjug
ICTSC5 大人達の戦い LT資料
ICTSC5 大人達の戦い LT資料
C++1z draft
C++1z draft
ユニキャスト本社のネットを支える技術
ユニキャスト本社のネットを支える技術
Oss貢献超入門
Oss貢献超入門
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:前半
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:前半
MyBatis を利用した web application 開発についてのご紹介
MyBatis を利用した web application 開発についてのご紹介
Oracle対応アプリケーションのDockerize事始め
Oracle対応アプリケーションのDockerize事始め
はじめてのDockerパーフェクトガイド(2017年版)
はじめてのDockerパーフェクトガイド(2017年版)
失敗と向き合う姿勢を正す話
失敗と向き合う姿勢を正す話
GitLabを16万8千光年ワープさせた話(改)
GitLabを16万8千光年ワープさせた話(改)
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:後半
期限内に問題を解決する技術(プロジェクトマネジメント・ワークショップ)公開スライド:後半
失敗事例で学ぶ負荷試験
失敗事例で学ぶ負荷試験
メルカリ カウルのマスタデータの更新
メルカリ カウルのマスタデータの更新
Recently uploaded
[DevOpsDays Tokyo 2024] 〜デジタルとアナログのはざまに〜 スマートビルディング爆速開発を支える 自動化テスト戦略
[DevOpsDays Tokyo 2024] 〜デジタルとアナログのはざまに〜 スマートビルディング爆速開発を支える 自動化テスト戦略
Ryo Sasaki
SOPを理解する 2024/04/19 の勉強会で発表されたものです
SOPを理解する 2024/04/19 の勉強会で発表されたものです
iPride Co., Ltd.
スマートフォンを用いた新生児あやし動作の教示システム
スマートフォンを用いた新生児あやし動作の教示システム
sugiuralab
TSAL operation mechanism and circuit diagram.pdf
TSAL operation mechanism and circuit diagram.pdf
taisei2219
【早稲田AI研究会 講義資料】3DスキャンとTextTo3Dのツールを知ろう!(Vol.1)
【早稲田AI研究会 講義資料】3DスキャンとTextTo3Dのツールを知ろう!(Vol.1)
Hiroki Ichikura
論文紹介:Automated Classification of Model Errors on ImageNet
論文紹介:Automated Classification of Model Errors on ImageNet
Toru Tamaki
論文紹介:Content-Aware Token Sharing for Efficient Semantic Segmentation With Vis...
論文紹介:Content-Aware Token Sharing for Efficient Semantic Segmentation With Vis...
Toru Tamaki
Open Source UN-Conference 2024 Kawagoe - 独自OS「DaisyOS GB」の紹介
Open Source UN-Conference 2024 Kawagoe - 独自OS「DaisyOS GB」の紹介
Yuma Ohgami
論文紹介:Semantic segmentation using Vision Transformers: A survey
論文紹介:Semantic segmentation using Vision Transformers: A survey
Toru Tamaki
Recently uploaded
(9)
[DevOpsDays Tokyo 2024] 〜デジタルとアナログのはざまに〜 スマートビルディング爆速開発を支える 自動化テスト戦略
[DevOpsDays Tokyo 2024] 〜デジタルとアナログのはざまに〜 スマートビルディング爆速開発を支える 自動化テスト戦略
SOPを理解する 2024/04/19 の勉強会で発表されたものです
SOPを理解する 2024/04/19 の勉強会で発表されたものです
スマートフォンを用いた新生児あやし動作の教示システム
スマートフォンを用いた新生児あやし動作の教示システム
TSAL operation mechanism and circuit diagram.pdf
TSAL operation mechanism and circuit diagram.pdf
【早稲田AI研究会 講義資料】3DスキャンとTextTo3Dのツールを知ろう!(Vol.1)
【早稲田AI研究会 講義資料】3DスキャンとTextTo3Dのツールを知ろう!(Vol.1)
論文紹介:Automated Classification of Model Errors on ImageNet
論文紹介:Automated Classification of Model Errors on ImageNet
論文紹介:Content-Aware Token Sharing for Efficient Semantic Segmentation With Vis...
論文紹介:Content-Aware Token Sharing for Efficient Semantic Segmentation With Vis...
Open Source UN-Conference 2024 Kawagoe - 独自OS「DaisyOS GB」の紹介
Open Source UN-Conference 2024 Kawagoe - 独自OS「DaisyOS GB」の紹介
論文紹介:Semantic segmentation using Vision Transformers: A survey
論文紹介:Semantic segmentation using Vision Transformers: A survey
ドキュメントを直し続ける話 #kbkz_tech
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)
9.
10.
11.
12.
1つ1つはたぶん簡単
13.
でも直し続けるのは 難しいと思う
14.
15.
どう直すの?
16.
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.
おわり
Download now