cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール
DESCRIPTION
ベータ版を始めるにあたって、ベータユーザー募集中です。 お気軽にご連絡ください。どうぞよろしくお願いします。 http://cumiki.comTRANSCRIPT
![Page 1: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/1.jpg)
エンジニアのための
ちょっといい感じの
ドキュメント作成ツール
![Page 2: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/2.jpg)
自己紹介
@ryooopan
twitter.com/ryooopan facebook.com/ryooopan github.com/ryooopan
独学ではじめてウェブサイトとか作る
この時PHPから入るというよくある間違いを(ry2010年 11月-
2011年 12月- バイトのインターンでiOSアプリとか
2012年 9月- Railsとかちょっとやりはじめる
今ココ ⇒KinectとProcessingとかでタンジブルなデバイス作ったり
NodeとArduino/Raspberry Piとかで楽器を作ったり
![Page 3: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/3.jpg)
本日エンジニアのみなさんにご紹介したいのは
ドキュメント作成ツールです
今までのよりちょっといい感じの
![Page 4: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/4.jpg)
みなさんの多くは誰かと
共同で開発されているかと思います
![Page 5: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/5.jpg)
他の人が書いたコードを読むのって
結構たいへん
でも
![Page 6: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/6.jpg)
自分の書いたコードを
他の人に説明するのって結構大事
だから
![Page 7: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/7.jpg)
方法1.コードにコメントを書く
「コード書いたから共有するね」という時に
方法2.ブログか何かにまとめる
![Page 8: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/8.jpg)
方法1.コードにコメントを書く
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!$.spam =-> [1..10000].forEach -> alert “I am spam”
ココ!
![Page 9: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/9.jpg)
方法1.コードにコメントを書く
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!$.spam =-> [1..10000].forEach -> alert “I am spam”不満:振り返りにくい
目次とかがないから
コードのポイントがつかみにくい
![Page 10: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/10.jpg)
$.spam =-> [1..10000].forEach -> alert “I am spam”
Daily Spam Blog
このメソッドは10000回のアラートを
出すことができます。
このコードを使いこなせれば、あな
たも立派なスパマーです。
メソッド呼び出しは... ココ!
方法2.ブログか何かにまとめる
2013-10-15 written by Spam Bot
![Page 11: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/11.jpg)
$.spam =-> [1..10000].forEach -> alert “I am spam”
このメソッドは10000回のアラートを
出すことができます。
このコードを使いこなせれば、あな
たも立派なスパマーです。
メソッド呼び出しは...
方法2.ブログか何かにまとめる
不満:コードと紐付いてない本当は更新されているのにブログのコードは古いまま...
2013-10-15 written by Spam Bot
Daily Spam Blog
![Page 12: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/12.jpg)
振り返りやすい
コードに紐付いてる
ブログに解説
コメントをつける
まとめると、こうなります
![Page 13: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/13.jpg)
振り返りやすい
コードに紐付いてる
コメントをつける
もうおわかりかもしれませんが
ブログに解説
![Page 14: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/14.jpg)
振り返りやすい
コードに紐付いてる
コメントをつける
Cumikiはココ
Cumikiブログに
解説
![Page 15: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/15.jpg)
どゆこと?
コードの上にメモを貼れる
GitHub・BitBucketにpushするだけ
コードを自動で追跡
ポイント①
ポイント②
ポイント③
![Page 16: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/16.jpg)
コードの上にメモを貼れるポイント①
![Page 17: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/17.jpg)
コードの上にメモを貼れるポイント①
今までのだと
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> [1..10000].forEach -> alert “I am spam”
Daily Spam Blog
このメソッドは10000回のアラー
トを出すことができます。
メソッド呼び出しは...
$.spam =-> [1..10000].forEach -> alert “I am spam”
コピペ
![Page 18: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/18.jpg)
コードの上にメモを貼れるポイント①
Cumikiだと
## Comment here $(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> [1..10000].forEach -> alert “I am spam”
マウスでピーってドラッグして...
ピー
![Page 19: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/19.jpg)
コードの上にメモを貼れるポイント①
## Comment here $(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> [1..10000].forEach -> alert “I am spam”
ぺたってメモを貼る
このメソッドは10000回のアラート
を出すことができます。
メソッド呼び出しは...
![Page 20: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/20.jpg)
コードの上にメモを貼れるポイント①
このメソッドは10000回のアラー
トを出すことができます。
メソッド呼び出しは...
$.spam =-> [1..10000].forEach -> alert “I am spam”
これだけで、コードに紐付いた
いい感じのメモができます
おわり
![Page 21: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/21.jpg)
コードを自動で追跡ポイント②
![Page 22: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/22.jpg)
コードを自動で追跡ポイント②
今までだと
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> [1..10000].forEach -> alert “I am spam”
Daily Spam Blog
このメソッドは10000回のアラー
トを出すことができます。
このコードを使いこなせれば、
あなたも立派なスパマーです。
$.spam =-> $(body).fadeOut() [1..10000].forEach -> alert “I am spam”
こっちでは追加したけど
こっちは更新されない
![Page 23: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/23.jpg)
コードを自動で追跡ポイント②
Cumikiだと
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> [1..10000].forEach -> alert “I am spam”
## Comment here$(“div”).click -> alert “Hello!”
## This is spam, Yeah!
$.spam =-> $(body).fadeOut() [1..10000].forEach -> alert “I am spam”
自動的に選択部分を
追跡していきます
更新しても
![Page 24: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/24.jpg)
コードを自動で追跡ポイント②
forkした先でメモをつけても
$.spam =-> [1..10000].forEach -> alert “I am spam”
$.spam =-> [1..10000].forEach -> alert “I am spam”
mergeするとちゃんとこっちでも
反映されます
なのでメモが全部最新のコードにたまっていきます
ぺた
![Page 25: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/25.jpg)
GitHub・BitBucketにpushするだけポイント③
![Page 26: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/26.jpg)
GitHub・BitBucketにpushするだけポイント③
$ git commit -m “update” $ git push origin master
## This is spam, Yeah!
$.spam =-> $(body).fadeOut() [1..10000].forEach -> alert “I am spam”
Cumikiで最新のコードにメモを取れます
![Page 27: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/27.jpg)
GitHub・BitBucketにpushするだけポイント③
private
もちろんプライベートレポジトリは
チーム内のみで共有
![Page 29: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/29.jpg)
組み木
ちなみに、名前の由来は
ネジとかを使わないで
木を組み合わせるだけで作る
日本の伝統技術
おもちゃから伝統建築まで
組み木みたいに
コードを組み立てるだけで
作りたいものができる
ことを目指しています
““
![Page 30: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/30.jpg)
今日持ってかえるモノ
Cumiki
ここは C です
さいごに
( CodeのC )
![Page 31: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/31.jpg)
どうもありがとうございました。
![Page 32: Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール](https://reader033.vdocuments.mx/reader033/viewer/2022052206/54835d46b4af9f8c0d8b4a75/html5/thumbnails/32.jpg)