#author("2022-04-22T05:05:33+00:00","default:admin","admin")
#author("2023-03-24T08:50:37+00:00","default:admin","admin")
*ドキュメント・コミュニケーション [#oab4af64]
-[[外資コンサルの基礎力「ドキュメント・コミュニケーション」は、業務効率化の必須スキル:https://hrnote.jp/contents/b-contents-editorial-sutoakadocument-190603/]]


*基本事項 [#oa2ed111]
**ドキュメンテーションの目的と心得 [#h905c6b6]
-完璧なドキュメントを書こうとしない。70点で合格。
-ドキュメントの共同所有を進めよう
-ドキュメントは気軽に書こう

*ドキュメンテーションする／しない？ [#kdac8e4c]
口頭で伝える人的負荷と「書かないリスク」を考える。

**ドキュメントの品質特性 [#bd271784]
-必要十分性 ... 目的を達成するために必要な情報が、過不足なく提供されているか？
-正確性
-- 情報の正確性 ... 情報が誤りなく提供されているか？
-- 表現の正確性 ... 情報が正しく表現されているか？
-わかりやすさ ... 内容が容易に理解できるようになっているか？
-検索しやすさ ... 欲しい情報がすぐに見つかるようになっているか？
-魅力 ... 読む気になるかどうか？
-法規・規約の遵守 ... 著作権を侵害していないか？差別的表現はないか？

*ドキュメンテーションの類型 [#e6e3bb77]
**リファレンスドキュメンテーション [#k6a035c5]
***ファイルコメント [#i045b393]
***クラスコメント [#cb472c22]
***関数コメント [#ib2794ca]

**デザインドキュメント [#d44fe657]

**チュートリアル [#u37e3b26]

**概念的ドキュメンテーション [#wd3a4de7]

**ランディングページ [#g465daf9]


*リンク集 [#r6034608]
-[[即活用！業務システムの開発ドキュメント標準化:http://www.thinkit.co.jp/free/project/4/1/1.html]]
トップ   編集 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS