techbooster.fm 第13回 「丸山さんとらこのドキュメントをもっと良くしたいESDocの話」


アイキャッチ

第13回「げんこうのじかん」
15

PODCAST : 今回の内容!

Rebuild.fmなど、技術情報をざっくばらんにお伝えするpodcastいい感じですよね!
というわけでtechboosterでも試しに初めて見ることにしました。初めて聞くひとはこちらからきいてね!

今回はらことゲストに丸山さん(@h13i32maru)を迎えて、ES6対応APIドキュメンテーションツールESDocを通じたドキュメントとソースコードの関係について。ドキュメントとエンジニアの付き合いって長いですからね。どう付き合っていくか、という姿勢を考えるきっかけになるはなしです

ハッシュタグ #techboosterfm

iOSの場合、 feedを http://techbooster.org/feed/podcast/ に設定すると上手くいくかも…。

SHOW NOTES

[00:30] 丸山さんのTwitterアカウントは@h13i32maruです(音声では伝えづらい)。
[04:00] APIドキュメンテーションツールESDoc。ドキュメントっていうと主語がデカいけどESDocではインストレーション、Usage、FAQもかける。APIリファレンスだけでは新規に導入しようとしてる開発者にリーチしきれない部分もあるからフォローしている。
[06:00] 他の言語でもドキュメンテーションツールに突出したすごいヤツはいない、もしかしてドキュメンテーションツールは進化していないのでは‥?
[10:30] ESDocのゴールは、コードを読むより書きやすく理解しやすいドキュメントを作ること。JSのすべてのドキュメントが一箇所にあるとスゴそう。
[13:45] 冬コミではESDocに込めた想いを解説します!丸山さん自身がESDoc開発者なので調べ物がない。進捗はいい。楽しみに待っていて欲しい

関連する記事: