Read The F*cking Manual
マニュアルを読め
公式文書、公式サイトへのリンクを用意する。
ググるな。個人の書いたメモを信用するな。
AIの出力を信用するな。
あるいは、ググった後、AIに出力させた後に公式文書を読んで検証せよ。
安易にコピペするな。
正しいことは基本的にマニュアルに書いてあるはずだ。
指針
公式文書、公式サイトへのリンクを作る
Google が広告とか何の保証もない個人ブログの方を先に出すとかマジでウンコになってきたので、仕方がない。
Wikipedia は悪くないのだが、どうでもいいところで細かすぎたり、足りなかったりする。
知らない固有名が出てきたら積極的に登録する。(実質、システム開発に特化した単語帳になりつつある)
追記することは以下の通り
公式文書が正しくない場合(!)の正しい情報
公式文書に書かれていない補足情報
公式文書に書いてあっても読解困難なことの補足情報
検討
コマンドごとにノートを書かなくても、結局の所、検索機能のあるトップページだけ書けばいいのかも。
脆弱性のあるサンプルをどこまで載せてよいか? (単純コピペ厳禁)
逆引きをどうするか? 表現をどうするのが望ましいのか。
結局の所、実際に展開されたバージョンに対する文書は展開されたところにしか存在しない。バージョン違いで挙動が異なることがある。
名称で正式名称と略称のどちらを書くべきか
略称の方が公式な名称であればそちらを使う。
分からない場合は、よく聞かれる名前の方を優先する。