SlideShare a Scribd company logo

Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール

•
•
Ryo Suzuki
Ryo Suzuki

ベータ版を始めるにあたって、ベータユーザー募集中です。 お気軽にご連絡ください。どうぞよろしくお願いします。 http://cumiki.com

1 of 32
めの た じの エ い感 ール い っと 作成ツ ちょ ント ュメ ドキ ンジ アの ニ
自己紹介 @ryooopan twitter.com/ryooopan facebook.com/ryooopan github.com/ryooopan 2010年 11月- 独学ではじめてウェブサイトとか作る この時PHPから入るというよくある間違いを(ｒｙ 2011年 12月- バイトのインターンでiOSアプリとか 2012年 Railsとかちょっとやりはじめる 9月- 今ココ ⇒ 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 -> り返 ：振 spam” 不 “I alert満 am ら ないか にくい とかが つかみ 目次 ントが のポイ コード
方法２.ブログか何かにまとめる Daily Spam Blog 2013-10-15 written by Spam Bot $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラートを 出すことができます。 このコードを使いこなせれば、あな たも立派なスパマーです。 メソッド呼び出しは... ココ！
方法２.ブログか何かにまとめる Daily Spam Blog 2013-10-15 written by Spam Bot $.spam =-> [1..10000].forEach -> alert “I am spam” 不満：コ このメソッドは10000回のアラートを ードと紐 出すことができます。 付いてな い このコードを使いこなせれば、あな 本当は更 新されて たも立派なスパマーです。 いるのに ブログの コードは 古いまま ... メソッド呼び出しは...
まとめると、こうなります 振り返りやすい ブログに 解説 コードに紐付いてる コメントを つける
もうおわかりかもしれませんが 振り返りやすい ブログに 解説 コードに紐付いてる コメントを つける
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 $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラー トを出すことができます。 メソッド呼び出しは...
ポイント① コードの上にメモを貼れる 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回のアラート を出すことができます。 メソッド呼び出しは... ぺたって メモを貼る
ポイント① コードの上にメモを貼れる $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラー トを出すことができます。 メソッド呼び出しは... これだけで、 コードに紐付いた いい感じの メモができます おわり
ポイント② コードを自動で追跡
ポイント② コードを自動で追跡 今までだと Daily Spam Blog ## Comment here $(“div”).click -> alert “Hello!” ## This is spam, Yeah! $.spam =-> $(body).fadeOut() [1..10000].forEach -> alert “I am spam” こっちでは 追加したけど こっちは 更新されない $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラー トを出すことができます。 このコードを使いこなせれば、 あなたも立派なスパマーです。
ポイント② コードを自動で追跡 Cumikiだと ## Comment here $(“div”).click -> alert “Hello!” ## Comment here $(“div”).click -> alert “Hello!” ## This is spam, Yeah! ## This is spam, Yeah! $.spam =-> [1..10000].forEach -> alert “I am spam” $.spam =-> $(body).fadeOut() [1..10000].forEach -> alert “I am spam” 更新しても 自動的に 選択部分を 追跡していきます
ポイント② コードを自動で追跡 forkした先で メモをつけても ぺた $.spam =-> [1..10000].forEach -> alert “I am spam” mergeすると ちゃんとこっちでも 反映されます $.spam =-> [1..10000].forEach -> alert “I am spam” なのでメモが全部 最新のコードに たまっていきます
ポイント③ 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
とりあえず つかってあそぼう！ http://cumiki.com （サインインしなくても遊べるようになって ）
ちなみに、名前の由来は 組み木 ネジとかを使わないで 木を組み合わせるだけで作る 日本の伝統技術 “ “ 組み木みたいに コードを組み立てるだけで 作りたいものができる おもちゃから伝統建築まで ことを目指しています
さいごに 今日持ってかえるモノ Cumiki ここは C です ( CodeのC )
どうもありがとうございました。
Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール

More Related Content

Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール