![](https://cdn-ak-scissors.b.st-hatena.com/image/square/380f21e9f8a705971af17fac800928f8d6039ab1/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Fadvent-calendar-ogp-background-f625e957b80c4bd8dd47b724be996090.jpg%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9JUU2JTlCJUI4JUUzJTgxJThGJUU2JThBJTgwJUU4JUExJTkzJUUzJTgzJUFDJUUzJTgzJTk5JUUzJTgzJUFCJUUzJTgyJUEyJUUzJTgzJTgzJUUzJTgzJTk3JUVGJUJDJTgxJUU4JUFBJUFEJUUzJTgxJUJGJUUzJTgyJTg0JUUzJTgxJTk5JUUzJTgxJTg0JUUzJTgzJTg5JUUzJTgyJUFEJUUzJTgzJUE1JUUzJTgzJUExJUUzJTgzJUIzJUUzJTgzJTg4JUUzJTgyJTkyJUU2JTlCJUI4JUUzJTgxJThGJUUzJTgxJTlGJUUzJTgyJTgxJUUzJTgxJUFCJnR4dC1jb2xvcj0lMjMzQTNDM0MmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmdHh0LWNsaXA9ZWxsaXBzaXMmdHh0LWFsaWduPWxlZnQlMkNtaWRkbGUmcz1hOTJhYWIyZjU0MTUyNmViMWY5YWVjNTRiOGU0NjEzNw%26mark-x%3D142%26mark-y%3D151%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwa2F0c3V5YV90YW5ha2EmdHh0LWNvbG9yPSUyMzNBM0MzQyZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTgxZmIzY2YzZmRmNTQ0NmM3OTJkYjljMTA0ODMyMTgz%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D429601f91f10e67324b9f3fc84cef72a)
エントリーの編集
![loading...](https://b.st-hatena.com/bdefb8944296a0957e54cebcfefc25c4dcff9f5f/images/v4/public/common/loading@2x.gif)
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
書く技術レベルアップ!読みやすいドキュメントを書くために - Qiita
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
![アプリのスクリーンショット](https://b.st-hatena.com/bdefb8944296a0957e54cebcfefc25c4dcff9f5f/images/v4/public/entry/app-screenshot.png)
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
書く技術レベルアップ!読みやすいドキュメントを書くために - Qiita
ドキュメントの前提となる情報は、自分にとっては明らかな内容でも、レビュワーや後工程の担当者にとっ... ドキュメントの前提となる情報は、自分にとっては明らかな内容でも、レビュワーや後工程の担当者にとっては未知のものかもしれません(前提質問の嵐が起きてしまうかも)。 何を理解していて、何を理解していないのかを整理した上で、前提情報を記載しましょう。 世の中の当たり前に忠実に作る 私の祖父が自転車を「けった」と呼んでも伝わらないように、世間一般と異なる表現は、ドキュメントにおいて理解を妨げます。 ドキュメントで使用する言葉や図は、読み手が理解できる「当たり前」のものであるべきです。 例: アクティビティ図の誤解 私は以前、アクティビティ図において、長方形をデータストアとオブジェクトだけでなく、アクションを表すのにも使用していました。これは、UMLの標準的な使い方に反していたため、読み手に混乱を与えてしまいました。 ドキュメントが、読み手の「当たり前」から外れないように、標準を知り準拠しましょう。