手順書の手順書 » 履歴 » バージョン 1
sylow castle, 2020/02/03 20:53
| 1 | 1 | sylow castle | 手順書の手順書 |
|---|---|---|---|
| 2 | ===== |
||
| 3 | |||
| 4 | ## 概要 |
||
| 5 | |||
| 6 | 自分がどんな風に手順とかを文書にまとめてるかを書く。 |
||
| 7 | |||
| 8 | ### お品書き |
||
| 9 | |||
| 10 | - 全体構成 |
||
| 11 | - 使用ツール |
||
| 12 | - レシピ |
||
| 13 | |||
| 14 | ### 全体構成 |
||
| 15 | |||
| 16 | 文書全体の構成をざっくりと考える。 |
||
| 17 | 最近安定してきた構成は |
||
| 18 | |||
| 19 | - タイトル（h1） |
||
| 20 | - キーワードリスト(リスト） |
||
| 21 | - 概要（h2） |
||
| 22 | - 手順（h2） |
||
| 23 | - お品書き(h3) |
||
| 24 | - 手順リスト（順序リスト） |
||
| 25 | - 「手順リスト」の第一項目（h3） |
||
| 26 | - 手順の文章とスクリーンショット |
||
| 27 | - 「手順リスト」の第二項目（h3） |
||
| 28 | - 手順の文章とスクリーンショット |
||
| 29 | - …「手順リスト」の項目がなくなるまで（h3） |
||
| 30 | - 参考・引用（h2） |
||
| 31 | |||
| 32 | という感じ。 |
||
| 33 | |||
| 34 | 一つ一つ見ていく。上記リストの括弧内は見出しのレベルを表す。h1ならh1タグに対応、h2ならh2タグに対応する。 |
||
| 35 | |||
| 36 | #### 「タイトル」 |
||
| 37 | |||
| 38 | 何の手順を記すのか決めるためにタイトルをつける。 |
||
| 39 | タイトルに書いた事柄が実現できるできるような内容にする。 |
||
| 40 | |||
| 41 | #### 「概要」 |
||
| 42 | |||
| 43 | その文書でどんなことを書くか決め、何ができるようになるかを書く。一文や二文で書くことが多い。 |
||
| 44 | だらだらと書くとよくわからなくなってくる。 |
||
| 45 | |||
| 46 | #### 「お品書き」 |
||
| 47 | |||
| 48 | 「手順リスト」だけ作ることが多い。「お品書き」と書かないことも結構ある。 |
||
| 49 | 各手順のタイトルを並べる。目次の替わり。 |
||
| 50 | |||
| 51 | #### 『「手順リスト」の第n項目』 |
||
| 52 | |||
| 53 | その項目でやる作業を文書で書く。本文。 |
||
| 54 | 説明対象がGUIを持っているならスクリーンショットを並べていく。 |
||
| 55 | 後述のRapture（おにぎり）というソフトをスクリーンショットを取るのもそんなに苦ではない。 |
||
| 56 | 説明対象がCUIを持っているならコマンドを並べていく。 |
||
| 57 | |||
| 58 | この時、画面に書かれている用語はそのまま鍵括弧つきにして記述すると伝わるし、 |
||
| 59 | 自分で言葉を考えなくて済むので楽ができる。 |
||
| 60 | ちょうどこの見出しのように。 |
||
| 61 | |||
| 62 | #### 参考・引用 |
||
| 63 | |||
| 64 | 自分ひとりでできることは少ない。 |
||
| 65 | 検索した結果得られた先人の知恵を借りることが多い。 |
||
| 66 | それらの人には敬意をこめて。タイトルとURLのリストを書いたりする。 |
||
| 67 | |||
| 68 | |||
| 69 | ### 使用ツール |
||
| 70 | |||
| 71 | #### スクリーンショットを撮る |
||
| 72 | |||
| 73 | 「Rapture」（通称おにぎり）： https://freesoft-100.com/review/rapture.html |
||
| 74 | スクリーンショット取りたいときはこれ使う。 |
||
| 75 | Windows 10に標準（？）でついている「Snipping Tool」もいい感じ。 |
||
| 76 | |||
| 77 | #### 文書形式とエディタ |
||
| 78 | |||
| 79 | 形式はMarkdownが多い。エディタはVisual Studioコードとか。 |
||
| 80 | あるいはMarkedjsを使った自作ツール（https://www.sylow-castle.work/memo/Editor.html ）とか。 |
||
| 81 | |||
| 82 | 別にメモ帳でもいいけど、画像を置いて見られるほうがいい。 |
||
| 83 | |||
| 84 | #### 画像編集 |
||
| 85 | |||
| 86 | MSペイント。画像編集は凝らない。というより、凝れない。 |
||
| 87 | |||
| 88 | ### レシピ |
||
| 89 | |||
| 90 | その他の文書中で使うもの。 |
||
| 91 | |||
| 92 | #### 「レシピ」 |
||
| 93 | |||
| 94 | ちょっとしたテクニックやそれらをまとめたもの。 |
||
| 95 | |||
| 96 | #### 具体例 |
||
| 97 | |||
| 98 | 少し抽象的なことを書く必要がある場合。例を出して具体化してやる。 |
||
| 99 | |||
| 100 | #### 意図・目的 |
||
| 101 | |||
| 102 | 手順の前に「何のために」を書くと読みやすいのかな。 |
||
| 103 | |||
| 104 | #### 失敗例 |
||
| 105 | |||
| 106 | これが文書化の動機だったりすることが多い。 |
||
| 107 | 望ましくない状況を書くことで見えることもある。 |
||
| 108 | |||
| 109 | #### 所感 |
||
| 110 | |||
| 111 | 思いを吐き出す場所。 |
||
| 112 | |||
| 113 | #### その他 |
||
| 114 | |||
| 115 | なんでもござれ。 |
||
| 116 | |||
| 117 | ### その他 |
||
| 118 | |||
| 119 | 個人的にはガチガチの手順は好みではないし、更新のコストがかかるので書きたくない。 |
||
| 120 | 更に言うと、そんな手順じゃなきゃ実行できない人に手順書を使わせたくない。 |
||
| 121 | 背後を何も考えずにやられるのも恐ろしい。（そういうことが必要な時もあるのは認めるけど） |
||
| 122 | |||
| 123 | ある程度分かっている人が備忘録的に使う手順が個人的には好きかな～。 |
||
| 124 | 自分がやったことの操作記録としての手順ならガチガチの手順で良いけど。 |