jQAPI - Alternative jQuery Documentation Browser
This is a alternative interface to browse the Official jQuery Documentation. It was created to get out of your way of your development work - quickly find what you are looking for, easy on the eyes, and lightning fast. Just start typing and see for yourself! FeaturesContent is the same as in the Official jQuery DocumentationStatically rendered pages powered by Astro, so the initial loading time is
本気でドキュメントを書くときに気をつけている10のこと - Masa / Lino Blog
テクニカルドキュメントを本気で書くときに気をつけていることをまとめてみます。 一応、私は雑誌等に執筆活動もやっています。 書き始める前 1. 目次を洗い出す ここでドキュメントの8割が決まるといっても過言ではないです。 この段階で抜け漏れ、重複を洗い出します。 特に複数人で執筆するときは特に重要です。 2. 書く内容をすべて実践する。 言うまでもないですが、テクニカルドキュメントは手を動かしてみないと書けません。 動かさないで書いてしまうと、嘘だらけのドキュメントが完成するでしょう。 テクニカルドキュメントではない場合は、全体をイメージします。 書いている途中 3. 文章は短く、シンプルに 同じことを伝えられるなら文章は短いほうが理解しやすいです。 ただ、舌足らずになるほど短くはしません。 根底にあるのはKISS(Keep It Simple, Stupid)です。 余談ですが、KISSは
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日本語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Java SE - Documentation
Subversion によるバージョン管理
『Linux標準教科書』開発プロジェクト - LPI-Japan - エルピーアイジャパン
ドキュメント作成に役立つ「日本語スタイルガイド」の紹介