Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール
•
36 likes•16,251 views
ベータ版を始めるにあたって、ベータユーザー募集中です。 お気軽にご連絡ください。どうぞよろしくお願いします。 http://cumiki.com
![方法１.コードにコメントを書く
ココ！
## Comment here
$(“div”).click ->
alert “Hello!”
## This is spam, Yeah!
$.spam =->
[1..10000].forEach ->
alert “I am spam”](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-8-320.jpg)
![方法１.コードにコメントを書く
## Comment here
$(“div”).click ->
alert “Hello!”
## This is spam, Yeah!
$.spam =->
くい
りに
[1..10000].forEach ->
り返
：振 spam”
不 “I
alert満 am
ら
ないか にくい
とかが つかみ
目次
ントが
のポイ
コード](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-9-320.jpg)
![方法２.ブログか何かにまとめる
Daily Spam Blog
2013-10-15 written by Spam Bot
$.spam =->
[1..10000].forEach ->
alert “I am spam”
このメソッドは10000回のアラートを
出すことができます。
このコードを使いこなせれば、あな
たも立派なスパマーです。
メソッド呼び出しは...
ココ！](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-10-320.jpg)
![方法２.ブログか何かにまとめる
Daily Spam Blog
2013-10-15 written by Spam Bot
$.spam =->
[1..10000].forEach ->
alert “I am spam”
不満：コ
このメソッドは10000回のアラートを
ードと紐
出すことができます。
付いてな
い
このコードを使いこなせれば、あな
本当は更
新されて
たも立派なスパマーです。
いるのに
ブログの
コードは
古いまま
...
メソッド呼び出しは...](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-11-320.jpg)
![ポイント①
コードの上にメモを貼れる
今までのだと
コピペ
## 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回のアラー
トを出すことができます。
メソッド呼び出しは...](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-17-320.jpg)
![ポイント①
コードの上にメモを貼れる
Cumikiだと
## Comment here
$(“div”).click ->
alert “Hello!”
マウスでピーって
ドラッグして...
## This is spam, Yeah!
$.spam =->
[1..10000].forEach ->
alert “I am spam”
ピー](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-18-320.jpg)
![ポイント①
コードの上にメモを貼れる
## Comment here
$(“div”).click ->
alert “Hello!”
## This is spam, Yeah!
$.spam =->
[1..10000].forEach ->
alert “I am spam”
このメソッドは10000回のアラート
を出すことができます。
メソッド呼び出しは...
ぺたって
メモを貼る](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-19-320.jpg)
![ポイント①
コードの上にメモを貼れる
$.spam =->
[1..10000].forEach ->
alert “I am spam”
このメソッドは10000回のアラー
トを出すことができます。
メソッド呼び出しは...
これだけで、
コードに紐付いた
いい感じの
メモができます
おわり](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-20-320.jpg)
![ポイント②
コードを自動で追跡
今までだと
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回のアラー
トを出すことができます。
このコードを使いこなせれば、
あなたも立派なスパマーです。](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-22-320.jpg)
![ポイント②
コードを自動で追跡
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”
更新しても
自動的に
選択部分を
追跡していきます](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-23-320.jpg)
![ポイント②
コードを自動で追跡
forkした先で
メモをつけても
ぺた
$.spam =->
[1..10000].forEach ->
alert “I am spam”
mergeすると
ちゃんとこっちでも
反映されます
$.spam =->
[1..10000].forEach ->
alert “I am spam”
なのでメモが全部
最新のコードに
たまっていきます](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-24-320.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で
最新のコードに
メモを取れます](https://image.slidesharecdn.com/cumiki-131017004250-phpapp01/85/Cumiki-26-320.jpg)
Cumiki - エンジニアのための、ちょっといい感じのドキュメント作成ツール
- 1. めの た じの エ い感 ール い っと 作成ツ ちょ ント ュメ ドキ ンジ アの ニ
- 2. 自己紹介 @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とかで楽器を作ったり
- 8. 方法１.コードにコメントを書く ココ！ ## Comment here $(“div”).click -> alert “Hello!” ## This is spam, Yeah! $.spam =-> [1..10000].forEach -> alert “I am spam”
- 9. 方法１.コードにコメントを書く ## Comment here $(“div”).click -> alert “Hello!” ## This is spam, Yeah! $.spam =-> くい りに [1..10000].forEach -> り返 ：振 spam” 不 “I alert満 am ら ないか にくい とかが つかみ 目次 ントが のポイ コード
- 10. 方法２.ブログか何かにまとめる Daily Spam Blog 2013-10-15 written by Spam Bot $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラートを 出すことができます。 このコードを使いこなせれば、あな たも立派なスパマーです。 メソッド呼び出しは... ココ！
- 11. 方法２.ブログか何かにまとめる Daily Spam Blog 2013-10-15 written by Spam Bot $.spam =-> [1..10000].forEach -> alert “I am spam” 不満：コ このメソッドは10000回のアラートを ードと紐 出すことができます。 付いてな い このコードを使いこなせれば、あな 本当は更 新されて たも立派なスパマーです。 いるのに ブログの コードは 古いまま ... メソッド呼び出しは...
- 17. ポイント① コードの上にメモを貼れる 今までのだと コピペ ## 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回のアラー トを出すことができます。 メソッド呼び出しは...
- 18. ポイント① コードの上にメモを貼れる Cumikiだと ## Comment here $(“div”).click -> alert “Hello!” マウスでピーって ドラッグして... ## This is spam, Yeah! $.spam =-> [1..10000].forEach -> alert “I am spam” ピー
- 19. ポイント① コードの上にメモを貼れる ## Comment here $(“div”).click -> alert “Hello!” ## This is spam, Yeah! $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラート を出すことができます。 メソッド呼び出しは... ぺたって メモを貼る
- 20. ポイント① コードの上にメモを貼れる $.spam =-> [1..10000].forEach -> alert “I am spam” このメソッドは10000回のアラー トを出すことができます。 メソッド呼び出しは... これだけで、 コードに紐付いた いい感じの メモができます おわり
- 21. ポイント② コードを自動で追跡
- 22. ポイント② コードを自動で追跡 今までだと 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回のアラー トを出すことができます。 このコードを使いこなせれば、 あなたも立派なスパマーです。
- 23. ポイント② コードを自動で追跡 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” 更新しても 自動的に 選択部分を 追跡していきます
- 24. ポイント② コードを自動で追跡 forkした先で メモをつけても ぺた $.spam =-> [1..10000].forEach -> alert “I am spam” mergeすると ちゃんとこっちでも 反映されます $.spam =-> [1..10000].forEach -> alert “I am spam” なのでメモが全部 最新のコードに たまっていきます
- 26. ポイント③ 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で 最新のコードに メモを取れます
- 30. さいごに 今日持ってかえるモノ Cumiki ここは C です ( CodeのC )
- 31. どうもありがとうございました。