ドキュメントのレガシー化、忘れていませんか？ APIマニュアルWEB化までの経緯
こんにちは。kzhirata@QAです。連休が近づいてきましたね。 今年の2月から部署移動したせいか、今年は暦通り休めそうな気がします。 （何か最近、ブログ書いているのQAの人が多い気がする...） 今回はテストに関する話ではありません。 今までGoogleDocsからPDFを作成していたAPIドキュメントをGithub Pages上にWEB化したことについてお話しします。現在、まだ完成していないので実際のWEBページのURLはお見せできませんが、下記キャプチャでイメージを掴んでいただければと思います。 現在、APIドキュメントは400ページ近くとなり、1つのGoogleDocsファイルにまとめきれなず、GoogleDocsのファイル数が10個以上となっています。 いわゆる「コードがレガシー」ならぬ「ドキュメントがレガシー」と化しています。 そんな状況で以前からAPIドキュメントをWEB化
わかりやすいREADME.mdを書く
GitHubなどに自分のツールやライブラリを公開するとき，README.mdは重要な役割を担っている．レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩はREADME.mdにかかっている，と言っても過言ではない．実際自分が使う側になったときも，まずREADME.mdを読んで判断していると思う． 成功しているプロジェクトを参考にしつつ，自分が実践していることをまとめておく．ここに書いていることはあくまで（自分の中で）最低限的なものである．プロジェクトが成長していくにつれてREADMEはあるべき姿に成長していくべきだと思う． READMEの役割 README.mdには大きく2つの役割がある． プロジェクト，ツールの使い方，インストール方法 プロジェクト，ツールの宣伝 元々READMEは前者の役割しかなかったが，GitHubの仕組み上，後者の役割も徐々に重要になっている． さらに
Dash - naoyaのはてなダイアリー
Twitter で知人に紹介したら周囲から「これは便利」という声が結構聞こえてきたので、ブログでも紹介しておこう。Dash というドキュメントビューワー。 iOS や RubyMotion、あるいは node や ruby そのほかのマニュアルをまとめてインクリメンタルサーチして API を調べる、ということができる。メジャーな色んな言語に対応している。 本来 Dash は "Snippet Manager" ということで、コードスニペットを管理するためのアプリケーションのようだけど自分は単なるドキュメントビューワーとしてしか使っていない。RubyMotion の勉強会に行ったときに、これが便利というのを教えてもらってその後愛用しています。主に iOS の開発のときに利用していた。 http://satococoa.github.com/blog/2013/01/22/view-rdoc-
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
