- 具体的なワードを使わないように注意すること
同業者や他のプログラマの方々が見ているかもしれないので、
具体的に現在のプロジェクトが悟られるようなエントリー内容は避けること。
注意すべきは
-
- 変数名
- 関数名
- テーブル名
- カラム名
- プロジェクト名
など。名前は、hogeやtestなど、具体的に何をしようとしているのか
分からないようにすることが重要である。
また、HTTPリクエストのサンプルを記述するときは、
URIをwww.hoge.comwww.example.comとかにすること。
- 出典は明記すること
どこのソースから情報を得る際は、出来るだけ情報を明記すること。
具体的には
-
- webページの場合そのページのリンクを貼る。
- 書籍はAmazonとかのリンクを貼る。
謝辞があるとなおよい。
- 記法を使いこなすこと
見てて分かりやすいエントリーを作ること
特に
- pre記法(コードを記述するときは必須)
- table記法(テーブルを作成するときに便利)
- 画像
を使いこなすのは重要であると言える。
これらを使い見て分かりやすいエントリーを作るべし。
