cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール
DESCRIPTION
ベータ版を始めるにあたって、ベータユーザー募集中です。 お気軽にご連絡ください。どうぞよろしくお願いします。 http://cumiki.comTRANSCRIPT
エンジニアのための
ちょっといい感じの
ドキュメント作成ツール
自己紹介
@ryooopan
twitter.com/ryooopan facebook.com/ryooopan github.com/ryooopan
独学ではじめてウェブサイトとか作る
この時PHPから入るというよくある間違いを(ｒｙ2010年 11月-
2011年 12月- バイトのインターンでiOSアプリとか
2012年 9月- Railsとかちょっとやりはじめる
今ココ ⇒KinectとProcessingとかでタンジブルなデバイス作ったり
NodeとArduino/Raspberry Piとかで楽器を作ったり
本日エンジニアのみなさんにご紹介したいのは
ドキュメント作成ツールです
今までのよりちょっといい感じの
みなさんの多くは誰かと
共同で開発されているかと思います
他の人が書いたコードを読むのって
結構たいへん
でも
自分の書いたコードを
他の人に説明するのって結構大事
だから
方法１.コードにコメントを書く
「コード書いたから共有するね」という時に
方法２.ブログか何かにまとめる
方法１.コードにコメントを書く
## 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 =-> [1..10000].forEach -> alert “I am spam”不満：振り返りにくい
目次とかがないから
コードのポイントがつかみにくい
$.spam =-> [1..10000].forEach -> alert “I am spam”
Daily Spam Blog
このメソッドは10000回のアラートを
出すことができます。
このコードを使いこなせれば、あな
たも立派なスパマーです。
メソッド呼び出しは... ココ！
方法２.ブログか何かにまとめる
2013-10-15 written by Spam Bot
$.spam =-> [1..10000].forEach -> alert “I am spam”
このメソッドは10000回のアラートを
出すことができます。
このコードを使いこなせれば、あな
たも立派なスパマーです。
メソッド呼び出しは...
方法２.ブログか何かにまとめる
不満：コードと紐付いてない本当は更新されているのにブログのコードは古いまま...
2013-10-15 written by Spam Bot
Daily Spam Blog
振り返りやすい
コードに紐付いてる
ブログに解説
コメントをつける
まとめると、こうなります
振り返りやすい
コードに紐付いてる
コメントをつける
もうおわかりかもしれませんが
ブログに解説
振り返りやすい
コードに紐付いてる
コメントをつける
Cumikiはココ
Cumikiブログに
解説
どゆこと？
コードの上にメモを貼れる
GitHub・BitBucketにpushするだけ
コードを自動で追跡
ポイント①
ポイント②
ポイント③
コードの上にメモを貼れるポイント①
コードの上にメモを貼れるポイント①
今までのだと
## 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”
コピペ
コードの上にメモを貼れるポイント①
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 =-> [1..10000].forEach -> alert “I am spam”
ぺたってメモを貼る
このメソッドは10000回のアラート
を出すことができます。
メソッド呼び出しは...
コードの上にメモを貼れるポイント①
このメソッドは10000回のアラー
トを出すことができます。
メソッド呼び出しは...
$.spam =-> [1..10000].forEach -> alert “I am spam”
これだけで、コードに紐付いた
いい感じのメモができます
おわり
コードを自動で追跡ポイント②
コードを自動で追跡ポイント②
今までだと
## 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”
こっちでは追加したけど
こっちは更新されない
コードを自動で追跡ポイント②
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”
自動的に選択部分を
追跡していきます
更新しても
コードを自動で追跡ポイント②
forkした先でメモをつけても
$.spam =-> [1..10000].forEach -> alert “I am spam”
$.spam =-> [1..10000].forEach -> alert “I am spam”
mergeするとちゃんとこっちでも
反映されます
なのでメモが全部最新のコードにたまっていきます
ぺた
GitHub・BitBucketにpushするだけポイント③
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で最新のコードにメモを取れます
GitHub・BitBucketにpushするだけポイント③
private
もちろんプライベートレポジトリは
チーム内のみで共有
組み木
ちなみに、名前の由来は
ネジとかを使わないで
木を組み合わせるだけで作る
日本の伝統技術
おもちゃから伝統建築まで
組み木みたいに
コードを組み立てるだけで
作りたいものができる
ことを目指しています
““
今日持ってかえるモノ
Cumiki
ここは C です
さいごに
( CodeのC )
どうもありがとうございました。
