Contenu connexe
Similaire à インフラエンジニアの綺麗で優しい手順書の書き方 (20)
インフラエンジニアの綺麗で優しい手順書の書き方
- 2. 自己紹介
湖山 翔平 / @sion_cojp
元FPSプロゲーマーでアジアチャンピオン
qiitaをよく書いてます (http://qiita.com/sion_cojp)
インフラエンジニアとしてよく使うコマンド集
インフラエンジニア
株式会社リブセンス
- 32. まとめると
1. 書き方を統一しよう
2. コードブロックにはsyntaxハイライトをつけよう
3. プロンプトは$で統一
4. 何をやってるか、コマンド毎に説明を書く
5. 手順書内完結を目指す
6. 文字数、行数、見出しの数は最小限に
7. ルー語禁止
8. 手順外、内で行ったり来たりしないようにする
9. 分岐が多いなら別の手順書に書きましょう
10.自分の感想や、昧な表現はさけましょう
11. 図は線は太く少なく、文字も太く見やすく
[チェック編]
12. 主題と内容に相違がないかチェック
13. 手順書が置かれてるディレクトリをチェック
14. 新卒でも分かるように書いてあるかチェック
15. 誤字脱字がないかチェック
16. 脳内でシミュレーションをして動作チェック