この記事は『Qiita Advent Calender 2022』の『Qiita史上最多記録をつくろう！アウトプットはいいぞカレンダー』参加記事です。
TL;DR.
- 対象が見たとき(見返したとき)に理解できるかどうかを気にかけよう
という自戒。
自分用の場合
- 自分がすでに持っていた知識は持っている前提で書いていい
- が、ど忘れしそうだなと直感的に思ったら検索ワードくらいは登場させとくといいかも
『homebrewでvlc落とす』
他の人が見るかもしれない場合
- 多少日本語に気を使ったほうがいいかもしれない
- 専門性が高い知識は自分がすでに知っていても参考記事くらいはおいたほうがいいかもしれない
- コマンドや関数はある程度パクれるようにしといてもいいかもしれない
『ターミナルでbrew install vlc』
他の人のために作る場合
- 説明文で変な日本語を書いて文章を破綻させない
- 自分が知ってる知識を相手が知っているとは限らない
- 相手の検索能力を過信しない
- コマンド一発でミスなく確実に済むならそのほうがむしろ説明しやすくて良いかも
『Launchpadからターミナルを探してクリックして開き、brew install vlcと入力してEnter』
共通
- でもアウトプットしないよりはしたほうが良い
ところで、この記事は自戒寄りなのでかなり適当ですね？