はじめに

私はよく技術記事を書いています。多くは自分自身が後で参照するためですが、せっかく書くのだから、多くの人に読んでもらいたいと思っています。記事の内容はともかく、形式や作法を整えるだけで、記事はずっと読みやすくなります。また、技術記事では、技術のバージョンや前提条件の重要性が高いため、ニュース記事の校正に用いられる視点とは異なる視点が必要になることがあります。私が個人的に最低限気をつけているポイントを挙げて、それを元にChatGPTに校正を依頼するためのプロンプトを作成しました。

目次

prompt
校正結果の before after を比較するコマンド
校正結果を ChatGPT で最後まで出力しきる Tips
最後に

prompt

あなたはIT技術分野のレポートのレビュアーです。
与えられたドキュメントに対して以下の校正を行う事を期待しています。
step by step で実行してください。

# 校正ルール
- 1. 校正は指摘事項とformat事項の両方を実施する
- 2. 指摘事項に関する内容をフィードバックする
- 3. 2の後に、ドキュメントにformat事項を適用した後の内容を全てを出力する
    - This is very important. otherwise, the next step will not work.
    - markdown の code block に出力してください
    
# 指摘事項
- 主題になっている技術のバージョンに関する明確な記述が無い場合に指摘をする
- 主題になっている技術の簡単な説明が無い場合に指摘をする
- 誤字や誤表現と思われる箇所を指摘する
- 似たような意味で利用している(表記が揺れている)言葉を指摘する

# format事項 (実施事項)
- markdown を使った表現に整える
- 英単語の前後にはスペースを挿入する
- です・ます調に整える
- "はじめに"という章を用意する
    - "# はじめに" という章をドキュメントの最初に用意する
    - "# はじめに"章の文が存在していなかった場合には、<ここにはじめにを書く>と記載する
- "最後に"という章を用意する
    - "# 最後に" という章をドキュメントの最後に用意する
    - 文に"最後までお読み頂きありがとうございます。励みになるので、良かったらいいね 👍 をお願い致します。" を記載する
- "目次"を`# はじめに`の次に用意する
    - HTMLの h1,h2 タグレベルの見出しから目次を作成する

# format事項 (禁止事項)
- 文章を丸ごと削ることをしない

校正の覚悟はできていますか?できているなら、"オレはできてる"と回答してください。

以下のように出力され、出力が続きます。

校正結果の before after を比較するコマンド

zsh 環境において、以下のコマンドを実行すれば簡単に before after を比較することができます。

cat << 'EOF' > after.txt
<ここに結果を貼る>
EOF

cat << 'EOF' > before.txt
<ここに原文を貼る>
EOF

git diff --no-index before.txt after.txt

ex. 以下のように表示されます。

校正結果を ChatGPT で最後まで出力しきる Tips

内容を省略して出力してくることへの対処
- 恐らく、 ChatGPT は出力の概要を示してくれているだけなので、<具体的な項目>から実行してみようと指示すると省略無しで出力してくれます
"続きを生成する" を実行するとエラーが起きる
- 画面をリロードした後に、続けてとコメントすると生成を再開することが多いです
  - 発生したエラー
  - "続きを生成する"ボタンでなく、続けてとメッセージすると再開することが多いです
- エラー原因がクォーターの場合は素直に待ちましょう

最後に

最後までお読み頂きありがとうございます。励みになるので、良かったらいいね 👍 をお願い致します。