作業メモをChatGPTでらくらく手順書化
この記事ではChatGPTを活用して日頃の作業メモから簡易マニュアルや手順書のような、後々でも参照できる文書を生成する方法を示します。
仕事中の「あれってどうするんだっけ」を無くしたい
実は最近転職しまして、新たな環境で心機一転頑張っているところです。
その中でどうしても課題になってしまうのが、
覚えることが多すぎて覚えきれない！！
というものです。
自分場合はIT（AI）関連の研究職に転職したので、以下のような事柄が覚えるべきこととして挙げられます。
人事、総務、経理関連の申請もろもろ
ITシステムの利用方法
研究開発用のPythonなど環境構築
直近で入る予定のプロジェクトのキャッチアップもろもろ
などなどなど
同じようなお悩みを抱えていらっしゃる方も多いのではないでしょうか？
しかし、おそらく多くの方も作業時にメモは取っているのではないかと思います。
ただ、説明の時だったり作業時にとっていたメモは断片的だったり、別々のファイルにまたがって書いてあったりして後で見返すのが大変だったりするのではないかと。
これらのメモを随時自分でまとめなおして後々からでも参照できる文書にしておくのが良いとは分かっていますが…
中々面倒な作業ですし、そんな時間があるかと言われると…という感じですよね。
そこでChatGPTなどAIさんにお任せしてしてしまおう！！というわけです。
ChatGPTで簡易マニュアル生成
以下は作業メモから手順書を作成するシンプルな例です。
ITの仕事だとよく発生する、サーバへのssh接続からpythonで作業する準備段階までのメモを仮想的に作ってみました。
# 2024/07/01作業メモ
案件での作業を行うためにサーバにsshで接続してpythonの環境構築を行う。
## サーバにsshで接続
まずwindowsにwindowsターミナルをインストール。
次にwindowsターミナルからサーバにsshで接続する。
先輩に教えてもらったサーバ名、ユーザ名、初期パスワードでログイン
$ ssh user@server
password: パスワードを入力
パスワードを初期パスワードから変更する
$ passwd
current password: <初期パスワード>
new password: <新パスワード>
retype new password : <新パスワード再度入力>
今日のタスクは完了。
# 2024/07/02作業メモ
昨日に続いて作業をする。
## サーバに公開鍵認証で接続する
パスワード認証ではなく公開か銀賞で接続するようにする。
以下の記事を参考に。
https://qiita.com/kazokmr/items/754169cfa996b24fcbf5
まずは接続元PCでキーペアを作成する。
$ mkdir ~/.ssh
$ cd ~/.ssh
$ ssh-keygen -t rsa -b 4096
次にできた公開鍵をサーバに送る
$ ssh-copy-id -i id_rsa.pub user@server
公開鍵方式で接続できるか確認
ssh -i id_rsa user@server
パスワードを聞かれずにログインできたらOK。
だが、以下のエラーが出てできなかった。明日詳細を調べる。
`WARNING: UNPROTECTED PRIVATE KEY FILE!...`
# 2024/07/03作業メモ
昨日のエラーを解消したい。
以下の記事によると、秘密鍵のパーミッションの問題らしい。
https://yachibit.hatenablog.jp/entry/2013/04/25/001912
パーミッションを変更
$ chmod 600 id_rsa
再度接続したらできた。
# 2024/07/04作業メモ
サーバ上でpythonの環境を構築する。
## 仮想環境構築
以下の記事を参考にvenvで仮想環境を作る。
https://qiita.com/fiftystorm36/items/b2fd47cf32c7694adc2e
$ python -m venv env
$ source env/bin/activate
これでpythonの仮想環境が出来た。そして、簡単なプロンプトとともに上記のメモをそのままChat-GPTに突っ込んでみます。
以下は日付順に作成した作業メモです。
このメモを基に、サーバにsshで接続してからpythonの仮想環境を作るまでの手順書を作成してください。
<先ほどのメモをコピペ>作成された手順書が以下です。（noteでの表示用に若干出力をいじっています。余計な空行の削除など。）
サーバにSSHで接続してからPythonの仮想環境を作る手順
1. Windowsターミナルのインストール
・Windowsターミナルをインストールします。
2. SSHでサーバに接続
・Windowsターミナルを起動します。
・次のコマンドでサーバにSSH接続します。先輩から教わったサーバ名、ユーザ名、初期パスワードを使用します。
$ ssh user@server password: パスワードを入力
3. パスワードの変更
・初期パスワードを変更します。
$ passwd
current password: <初期パスワード>
new password: <新パスワード>
retype new password: <新パスワード再度入力>
4. 公開鍵認証の設定
・公開鍵認証で接続するために、接続元PCでキーペアを作成します。
$ mkdir ~/.ssh $ cd ~/.ssh $ ssh-keygen -t rsa -b 4096
・作成した公開鍵をサーバに送信します。
$ ssh-copy-id -i id_rsa.pub user@server
・公開鍵認証で接続できるか確認します。
$ ssh -i ~/.ssh/id_rsa user@server
・次のエラーが表示された場合は、秘密鍵のパーミッションを変更します。
WARNING: UNPROTECTED PRIVATE KEY FILE!...
$ chmod 600 ~/.ssh/id_rsa
・再度接続を試みます。
$ ssh -i ~/.ssh/id_rsa user@server
5. Python仮想環境の構築サーバに接続後、Pythonの仮想環境を構築します。
$ python -m venv env $ source env/bin/activate
これでPythonの仮想環境が構築されました。
ちなみに上記をmarkdownにまとめてもらうこともやってもらいましたが、こちらは何往復かしないと所望のものが出てきませんでした。
コードスニペットの中に入れてもらったり、一部だけmarkdownになっていたり…
結果が返ってくるたびに「コードスニペットの中に入れてください」、「3章以降がmarkdownになっていません」など支持する必要がありました。
プロンプト
上記をmarkdownファイルで書いてください。
コードスニペットの中に記述して、ブラウザ上で勝手にフォーマットされないようにしてください。Chat-GPTの出力
以下がMarkdown形式の手順書全体です。
```
# サーバにSSHで接続してからPythonの仮想環境を作る手順
## 1. Windowsターミナルのインストール
- Windowsターミナルをインストールします。
## 2. SSHでサーバに接続
- Windowsターミナルを起動します。
- 次のコマンドでサーバにSSH接続します。先輩から教わったサーバ名、ユーザ名、初期パスワードを使用します。
```sh
$ ssh user@server
password: パスワードを入力
```
## 3. パスワードの変更
- 初期パスワードを変更します。
```sh
$ passwd
current password: <初期パスワード>
new password: <新パスワード>
retype new password: <新パスワード再度入力>
```
## 4. 公開鍵認証の設定
- 公開鍵認証で接続するために、接続元PCでキーペアを作成します。
```sh
$ mkdir ~/.ssh
$ cd ~/.ssh
$ ssh-keygen -t rsa -b 4096
```
- 作成した公開鍵をサーバに送信します。
```sh
$ ssh-copy-id -i id_rsa.pub user@server
```
- 公開鍵認証で接続できるか確認します。
```sh
$ ssh -i ~/.ssh/id_rsa user@server
```
- 次のエラーが表示された場合は、秘密鍵のパーミッションを変更します。
```sh
WARNING: UNPROTECTED PRIVATE KEY FILE!...
```
```sh
$ chmod 600 ~/.ssh/id_rsa
```
- 再度接続を試みます。
```sh
$ ssh -i ~/.ssh/id_rsa user@server
```
## 5. Python仮想環境の構築
- サーバに接続後、Pythonの仮想環境を構築します。
```sh
$ python -m venv env
$ source env/bin/activate
```
これでPythonの仮想環境が構築されました。
```まとめ
いかがでしょうか？
作業メモをそのまま残すよりは、ある程度人に読んでもらうこともできる文書の形になったのではないでしょうか。
「先輩に教えてもらった～～」辺りはもう少し書き方があるのではないかとも思いますが（笑）、これくらいなら後で自分で書き直しても良いですね。
もし、「メモが貯まっていく一方でまとまらない！！」と思っていらっしゃるなら、このように生成AIの力を借りてみても良いかもしれません。
この記事が参加している募集
この記事が気に入ったらサポートをしてみませんか？