1年かけてAnewsのドキュメントを改善した話
エンジニアリングユニットの酒井といいます。 昨年の9月に入社し、Anewsの開発に従事しつつ時々SREっぽいこともしています。 今回は、自分が入社当初から改善したいなぁと考えていたAnewsのドキュメントについて、これまでやってきた取り組みについてお話しできればと思います。 取り組みを始めたきっかけそもそも自分は組織開発において、ドキュメントが重要だという認識がありました。それはこれまでの経験則によるところもありますし、『Googleのソフトウェアエンジニアリング』中で以下のような言及があり、重要性を再認識したというのもあります。 10.2 何故ドキュメンテーションが必要なのか p220: ドキュメンテーションは長期的に見ると決定的に重要であり、決定的に重要なコードにとっては特に、組織がスケールするのに伴い途方もない恩恵をもたらす。 テストを書くことは普通になりつつありますが、ドキュメント
Become An Xcoder の Leopard 版が出た - きりかノート
Mac + Xcode での C/Objecive-C プログラミング入門ガイド「Become An Xcoder」（関根さんによる日本語訳）という PDF が配布されているのを知っている人は多いと思うけど、 その Leopad 版が最近公開されました。今は英語のみで、旧版も Tiger 用として入手可能なままとなっている。 簡単に旧版と目次を比較してみた。テキスト化->diff。 % diff -w -U1 tig-toc.txt leo-toc.txt @@ -11,5 +11,6 @@ Declaring a variable -Mathematical operations +Data Types Parentheses Division +Booleans Modulus @@ -27,2 +28,3 @@ Making it all work +Shielded variabl
jQuery documentation (CHM)
jQuery documentation in chm format. jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. jQuery is designed to change the way that you write JavaScript. jquery.com Jan 20, 2010 jQuery 1.4 jquery-1.4.chm.7z (1.8 MB) Jan 15, 2009 Update for jQuery 1.3: jquery-api-20090115.chm (19
【レビュー】Googleドキュメントをオフラインとつなぐ「OOO2GD」はいかが? (1) 「OOO2GD」はGoogleドキュメントの欠点を補う? | ネット | マイコミジャーナル
「Googleドキュメント」をいかす「OOO2GD」 最近はローカルコンピュータ上で使われていたソフトウェアをブラウザ上で動かす、いわゆる"Webアプリケーション"が次々に登場している。タスク管理やグループウェアもそのひとつだが、もっともビジネスで使われるのは表計算やワードプロセッサをはじめとするオフィススイートだろう。そして、それをWebアプリケーション化したもので有名なのが「Googleドキュメント」だ(図1)。 【図1】「Googleドキュメント」のトップページ Googleドキュメントはワードプロセッサの「文書」、表計算の「スプレッドシート」、プレゼンツールの「プレゼンテーション」で構成されている。従来のような「ローカルで文書を作成してメールで送る」という形態ではなく、「ブラウザ上で作成してそのまま共有する」という新しいオフィス文書の活用法が期待できる便利なWebアプリケーションだ
MOONGIFT: » ついに出た！MS OfficeとGoogleドキュメントの同期ツール「DocSyncer」:オープンソースを毎日紹介
OpenOfficeとGoogleドキュメントを相互にやり取りできるOOO2GD、これは素晴らしいソフトウェアだ。一般ユーザであればぜひ使ってみて欲しい。が、ビジネスとなると（特に日本では）OpenOfficeではなくMS Officeが一般的だ。 MS OfficeとGoogleドキュメントが同期できたとすればどれだけ便利になるだろうか。そんな夢を叶えてくれるソフトウェアがこれだ。 今回紹介するフリーウェアはDocSyncer、ローカルのオフィスドキュメントとGoogleドキュメントを同期してくれるソフトウェアだ。 まさに必要としていたソフトウェアだ。DocSyncerをインストールすると、ローカル（恐らくローカルプロファイル以下のみ対象）にあるオフィスドキュメントをDocSyncerのサービスサイト上にアップロードする。常駐型で、指定ファイルを同期するという方法ではないようだ。 そして
Rubyのオンラインドキュメントをローカルで閲覧する方法 - 暴想
最近、オンラインマニュアル(http://www.ruby-lang.org/ja/man/)が503 Service Unavailableでなかなか閲覧できなくて、仕事に支障が出ていて困り果てていたところ、ruby-listにローカルで閲覧するアーカイブが紹介されていた。 助かった。 RubyForge: RDE: ファイルリスト ちなみに、chm形式なのでMacだと専用アプリをダウンロードする必要がある。 Chemr - subtech(intel mac限定・・) Life with Mac OS X @rNote - Chmox 日本語対応版(power pc向けだけど、検索ができなくて致命的) ところで、一度ローカルで動かしたらあまりにも便利だということに気がついた。検索とか凄く早く出るし、閲覧しやすい。これはいいや。 ↓1日1ポチッとをお願いします！励みになります！
RDoc をインクリメンタルサーチする greasemonkey スクリプト - 2nd life (移転しました)
http://rails2u.com/misc/rdocincsearch.user.js 今現在、ruby ライブラリのドキュメントは rdoc で生成するのが一般的です。その中のドキュメント生成の方法の一つのフォーマットに html があり、ライブラリドキュメントの Web の公開形式といえば rdoc が生成した html がスタンダードな感じです。また rubygems をインストールすると使える、ローカルで httpd(webrick) を起動してライブラリドキュメントを閲覧できる gem_server も rdoc の html を利用して表示しています。 しかし、rdoc の出力する html は検索ができないので、たくさんのメソッドから必要なメソッドを探すのに苦労します。そんなわけで rdoc を JavaScript でインクリメンタルサーチできるようにする grease
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://memotune.com/r