技術文書を書くための７つのルール
技術文書を書くための７つのルール¶ さまざまな面から見て、良いドキュメントを書くことは、良いコードを書くよりも簡単です。多くの開発者はドキュメントを書くのはとても難しいことであると考えていますが、いくつかのシンプルなルールに従うだけで、本当に簡単になります。 ここでお話しするのは、ポエムの本を書くための方法ではなく、プログラムの設計やAPI、コードベースを作り上げる上で、必要となるものを理解するための包括的なテキストを書くための方法になります。 全ての開発者はそのようなテキストを書くことができます。本節ではあらゆる場面で適用できる7つのルールを提供します。 ２つのステップで書く: まずはアイディアにフォーカスし、その後レビューを行ってテキストの形を整えます。 読者のターゲットを明確にする: それを読むのはだれですか？ シンプルなスタイルを使用する: 分かり易くシンプルに保ちます。正しい文法
橋本商会 » mongoid使ってみる
mongo単体で使ってみててだいたい分かったので、mongoidというmapperを使ってみる。 mongoidの良いのは default値を入れておきたい場合も簡単に書ける。created_atとか。 _idでdocumentを取り出すとき、素のmongoだとcollection.find_one(BSON::ObjectID(id))とかしないとならないけどmongoidだと_idに文字列でID入れればいい とかがぱっと使ってみて思った。。 そもそもこういうのmongoの機能にあるかもしれないけど。 ■ドキュメント mongodbインストール – 橋本詳解 Macにインストールした Rubyからmongo使う – 橋本詳解 Ruby Tutorial – MongoDB MongoRuby-1.0.7 mongoドライバのドキュメント ハンズオンで分かる MongoDB チュートリアル
Ruby/Railsのコードを読むにはroccoとrdefsが便利：Rails Hub情報局：エンジニアライフ
新年明けましておめでとうございます。今年こそRuby/Railsをやってみようという人もいるかと思います。ここではRubyのコードを読むのに便利なツールを2つほどご紹介したいと思います。 ドキュメント生成ツールのRD、RDoc、SDoc ソースコードに埋め込んだコメントを、そのままドキュメントとして抽出するツールがRubyにはいろいろあります。いちばん古くからあるのは、RD（Ruby Document Format）と呼ばれるもので、Markdownなどと同様に構造を記述できます。 現在、Rubyに標準添付されているのはRDocです。RubyのソースコードからHTML＋CSS＋JavaScriptを吐き出して、ブラウザで閲覧しやすくしてれます。もう1つ、RDocに似たものにSDocがあります。Sはsearchableのことで、ブラウザ上でクラスやメソッド名をインクリメンタル検索できるのが特
[review] 7つの言語 7つの世界 - KeN's GNU/Linux Diary(2011-08-23)
View this post on Instagram A post shared by kmuto (@mutokenshi) View this post on Instagram A post shared by kmuto (@mutokenshi) View this post on Instagram A post shared by kmuto (@mutokenshi) View this post on Instagram A post shared by kmuto (@mutokenshi) 先日はMackerel Webhookを処理するライブラリをGoogle Chat通知の実装例込みでRuby版で作っていた。 kmuto.hatenablog.com しかし、今日びRubyだとあまりありがたがられなくなってしまっているので、TypeScriptで書いたnpmも作
![[review] 7つの言語 7つの世界 - KeN's GNU/Linux Diary(2011-08-23)](https://cdn-ak-scissors.b.st-hatena.com/image/square/06a15c64ba0ceec233d86d71001ebb29a9dcbf5d/height=288;version=1;width=512/https%3A%2F%2Fcdn.blog.st-hatena.com%2Fimages%2Ftheme%2Fog-image-1500.png)
WebOSカタログ（2007年5月版）
唯一日本で運営されているWebOS。 運営はフュージョン・ネットワークサービス株式会社が実施。 Windowsライクなユーザーインタフェース。 StartForce 上で動作するアプリケーションを開発するためのAPIや開発用ドキュメントが公開されている。 開発したアプリケーションは申請（アプリケーション申請ツールを利用）によってStartForce上で公開され、 他の利用者からアプリケーション購読することが可能。 ファイルエクスプローラ（ファイル管理） スタートフォース ライター（エディタ） EditGrid（表計算ソフト） スタートフォース メッセンジャー ニュースリーダ（RSSリーダー） 画像ビューア メディアプレイヤー オーディオプレイヤー 計算機 チェス/リバーシ（ゲーム） システムコンソール（コマンドコンソール） デスクトップ設定 アプリケーション購読（アプリケーション管理ツール
ソフトウェアレビューが成功する進行役の6条件
ともすると漫然と取り組んでしまいがちなソフトウェアレビューだが、メンバー1人1人の役割を明確化すれば、非常に効率的に行うことができる。中でも司会進行役は、レビューの結果を左右する大きなカギを握ることになる。 レビューに“役割”が必要なこと、認識していますか？ 第3回『“読み方”を知って、レビューをもっと効果的に 』では、まず「何のためにレビューを行うのか」という目的を認識し、それに最適なドキュメントやソースコードの読み方を採用することで、レビューを効率的に行えることを解説しました。今回はその続編として、「レビューにおける役割分担」を紹介したいと思います。 レビューは進め方の自由度が高い分、参加者1人1人の役割があいまいになりがちなものです。そこで最初に適切な役割分担を行い、1人1人が自身の役割に集中するように心掛けると、レビューの効果・効率を大幅に高めることができます。 例えば、皆さんの周
ドキュメント作成に参考になる公開ドキュメント集
Webシステムにてドキュメントを作る際に参考になる公開されているドキュメントを集めてみました。 見た限りはどれも無償で利用可能なようですが、実際に利用される際は規約等をご確認下さい。 発注者ビューガイドライン http://sec.ipa.go.jp/reports/20080710.html 形式：[PDF] IPAが公開しているドキュメント作成ガイドラインです。 発注者とSIerの間で意思疎通を図ることを目的としているので、内容も詳細でかつ分かりやすいです。分量がかなり多いのですが、JavaでおなじみのPet Storeを題材に具体的なドキュメントが載っているので、ざっと見てみるだけでも参考になると思います。 ただ小規模案件だと、このガイドラインどおりに全てのドキュメントを揃えるのはムリがあると思うので、使えそうな部分だけ上手く利用するのが良いでしょう。 関連書籍も出ているようなので、
JsDoc Toolkitによる開発効率向上を目指して （1/3）－ ＠IT
JavaScript開発を見直そう（前編） JsDoc Toolkitによる開発効率向上を 目指して 遠藤 太志郎 株式会社インテック ネットワーク＆アウトソーシング事業本部 2009/6/9 JavaScriptを使った開発で、ソースの保守性や再利用性までを視野に入れたドキュメントを残しているだろうか。Ajaxを使った高機能なWebサービスなど、JavaScriptによる開発規模は拡大している（編集部） システムエンジニアならば、JavaScriptという言葉は誰でも聞いたことがあるだろう。Webブラウザ上で動作し、主にWebブラウザのユーザーインターフェイスの向上を目的に使用されるプロトタイプベースのオブジェクト指向型スクリプト言語だ。 JavaScriptは、世に出てからしばらくの間は特にそれほど脚光を浴びるような技術ではなかったのだが、2005年にGoogleがGoogle Map
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
