第6回 | メモと手順を残す場所を作る | README.mdとnotes.mdの使い分け｜UNIX Cafe

第６回 | WindowsからはじめるLinuxターミナル

前回は、vi とターミナルを行き来して、編集後に確認する流れを見ました。今回は、作業メモと手順を残す場所を作ります。

ターミナルで作業していると、コマンドの履歴は残ります。ただ、履歴だけでは「なぜその作業をしたのか」「次に何を確認するのか」までは分かりません。そこで、短いメモをファイルに残しておきます。

この記事で学べること

• README.md と notes.md の役割分け
• 作業場所の目的を短く残す方法
• 今日やったこと、次にやることをメモする考え方
• 作業の最後に、ファイルと中身を確認する流れ

作業場所を確認する

まず、作業用ディレクトリにいるか確認します。

pwd

pwd

表示される内容は環境によって変わります。たとえば、作業用のディレクトリを作っている場合は、次のように表示されます

/home/mina/workspace

/home/mina/workspace

この記事の表示例にある mina は、サンプル用のユーザー名です。自分のパソコンでは、自分が設定したユーザー名が入った /home/自分のユーザー名/workspace のように表示されます。名前が違っても、操作はそのまま進められます。

続いて、ファイル一覧を確認します。

ls

ls

次のように、ファイルの一覧が表示されます。

notes.md
projects
README.md

notes.md
projects
README.md

README.mdの役割

README.md は、作業場所そのものの説明を書くファイルです。一方、notes.md は、作業中に気づいたことや、次にやることを書くメモです。

vi README.md

vi README.md

たとえば、次のような内容を書きます。

# WindowsからはじめるLinuxターミナル 練習用ワークスペース

このディレクトリは、ターミナル操作の練習に使う作業場所です。

# WindowsからはじめるLinuxターミナル 練習用ワークスペース

このディレクトリは、ターミナル操作の練習に使う作業場所です。

保存したら、cat で表示してみます。

cat README.md

cat README.md

cat は、ファイルの中身をそのまま画面に表示するコマンドです。この場合は、README.md の中身が表示されます。

notes.mdの役割

notes.md には、作業中のメモを書きます。今日やったこと、気づいたこと、次に確認することを書いておくと、あとで再開しやすくなります。

vi notes.md

vi notes.md

たとえば、次のような形にしておきます。

# 作業メモ

## 今日やったこと

- 現在地を確認した
- README.md の役割を決めた
- notes.md に作業メモを残した

## 次に確認すること

- よく使うコマンドは何か
- 使っていない設定はないか

# 作業メモ

## 今日やったこと

- 現在地を確認した
- README.md の役割を決めた
- notes.md に作業メモを残した

## 次に確認すること

- よく使うコマンドは何か
- 使っていない設定はないか

保存したら、こちらも cat で確認します。

cat notes.md

cat notes.md

先ほど作成した、notes.md の中身が表示されます。

きれいな文書にしすぎない

作業メモは、最初からきれいな文書に仕上げようとしなくて大丈夫です。大切なのは、次に開いた自分が作業を再開できることです。

• 何をしたか
• どこまで確認したか
• 次に何を見るか

この3つが残っていれば、作業メモとして十分役に立ちます。

今日のまとめ

• README.md には、作業場所の目的を書く
• notes.md には、作業中のメモを書く
• 作業メモは、きれいさより再開しやすさを優先する
• 保存したら cat で内容を確認する

次回予告

次回は、ここまで整えた環境を見直しながら、自分の作業環境を少しずつ育てる考え方を整理します。