ドキュメンテーション
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
*ドキュメント・コミュニケーション [#oab4af64]
-[[外資コンサルの基礎力「ドキュメント・コミュニケーション...
*基本事項 [#oa2ed111]
**ドキュメンテーションの目的と心得 [#h905c6b6]
-完璧なドキュメントを書こうとしない。70点で合格。
-ドキュメントの共同所有を進めよう
-ドキュメントは気軽に書こう
*ドキュメンテーションする／しない？ [#kdac8e4c]
口頭で伝える人的負荷と「書かないリスク」を考える。
**ドキュメントの品質特性 [#bd271784]
-必要十分性 ... 目的を達成するために必要な情報が、過不足...
-正確性
-- 情報の正確性 ... 情報が誤りなく提供されているか？
-- 表現の正確性 ... 情報が正しく表現されているか？
-わかりやすさ ... 内容が容易に理解できるようになっている...
-検索しやすさ ... 欲しい情報がすぐに見つかるようになって...
-魅力 ... 読む気になるかどうか？
-法規・規約の遵守 ... 著作権を侵害していないか？差別的表...
*ドキュメンテーションの類型 [#e6e3bb77]
**リファレンスドキュメンテーション [#k6a035c5]
***ファイルコメント [#i045b393]
***クラスコメント [#cb472c22]
***関数コメント [#ib2794ca]
**デザインドキュメント [#d44fe657]
**チュートリアル [#u37e3b26]
**概念的ドキュメンテーション [#wd3a4de7]
**ランディングページ [#g465daf9]
*リンク集 [#r6034608]
-[[即活用！業務システムの開発ドキュメント標準化:http://ww...
終了行:
*ドキュメント・コミュニケーション [#oab4af64]
-[[外資コンサルの基礎力「ドキュメント・コミュニケーション...
*基本事項 [#oa2ed111]
**ドキュメンテーションの目的と心得 [#h905c6b6]
-完璧なドキュメントを書こうとしない。70点で合格。
-ドキュメントの共同所有を進めよう
-ドキュメントは気軽に書こう
*ドキュメンテーションする／しない？ [#kdac8e4c]
口頭で伝える人的負荷と「書かないリスク」を考える。
**ドキュメントの品質特性 [#bd271784]
-必要十分性 ... 目的を達成するために必要な情報が、過不足...
-正確性
-- 情報の正確性 ... 情報が誤りなく提供されているか？
-- 表現の正確性 ... 情報が正しく表現されているか？
-わかりやすさ ... 内容が容易に理解できるようになっている...
-検索しやすさ ... 欲しい情報がすぐに見つかるようになって...
-魅力 ... 読む気になるかどうか？
-法規・規約の遵守 ... 著作権を侵害していないか？差別的表...
*ドキュメンテーションの類型 [#e6e3bb77]
**リファレンスドキュメンテーション [#k6a035c5]
***ファイルコメント [#i045b393]
***クラスコメント [#cb472c22]
***関数コメント [#ib2794ca]
**デザインドキュメント [#d44fe657]
**チュートリアル [#u37e3b26]
**概念的ドキュメンテーション [#wd3a4de7]
**ランディングページ [#g465daf9]
*リンク集 [#r6034608]
-[[即活用！業務システムの開発ドキュメント標準化:http://ww...
ページ名:
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
