【GPTs開発】GithubのREADME.md作成を簡単に！

ソフトウェアエンジニアのホーリーデイ（@holy519）です。
ChatGPT研究所さん主催のGPTsハッカソンへのエントリー記事です。

話題のGPTsを今回初めて作成しました。
日頃、AIの業務に携わっているのにお恥ずかしい。

今回作成したGPTsは私がGithubのREADMEを作成するときに困ったことを解決できるようにしました。

作成しようと思った背景

未経験からエンジニアに転職した私はGithubで他人に共有した経験がありませんでした。その中で私が書き足りない部分を質問して補ったり、不要な記述があれば再構成するGPTが欲しいと感じて作ろうと思いました。

作成したGPTs【Markdown Magician】

下記のリンクからGPTsが使用できます。

ChatGPT - Markdown Magician

実演：ブログサイト作成のREADME

使い方の紹介として実際の質問を投げていきます。

READMEで記述すべき基本的な構成が出力されました。
引き続き具体的な要件を入力していきます。

コピーペーストするとREADMRに反映されるｍmarkdown形式で出力されることがポイントです。
追加で特定の部分に対して掘り下げることができます。

GPTsのプロンプト

プロンプトの内容を紹介します。
特殊な設定は特に行っていません。
私は初めての作成だったためCreateで対話形式で作成しました。
※特にこだわりたい方はConfigureを使用した方が思った出力形式を作り出せます。

Instructions

Markdown Magicianは、GitHubのREADME、Markdownのフォーマット、MRの準備を支援するカジュアルでフレンドリーなGPTです。

対話している過程で記述されます。
同期と一緒に相談しているような雰囲気が良かったのでフレンドリーなパーソナル設定にしています。

機能について

##機能
READMEに入力する部分をMarkdown形式で出力し、補足説明はそれらの最後に記述
ユーザーが提供するコードやテキストをMarkdown記法に変換し、フォーマットを維持して出力
明確で、簡潔で、プロフェッショナルな文書を作成するための理想的な支援を提供
説明に不要な内容は省略

機能についても明確に言及しておくことで出力形式が一定になります。

進め方について

##進め方
step by stepで段階的に深堀りする
わからないところは質問をして補填する
**ユーザーに、深掘りを終えて次のステップに行っていいか確認する。確認ができるまで次に行かない**
構成に対してフィードバックしながら、改善していく

大規模言語モデルではstep by stepと段階的に解決を促すことで、言語モデルの精度が高くなる結果が出ています。

特に強調したい部分に**を追加して強調しています。
深堀りしたいところを再確認することで薄くなりがちな内容を補填することができます。

Conversation starters

ここでは、試しに使用しやすい語句を並べています。
今後使いやすいような一言を厳選していきたいとかんがえています。

その他

その他にも様々な追加機能があります。

• Knowledge

• Capabilities

• Actions

この3つに関しては無くても正常に動作はします。
より精度のよいGPTsを作成したい場合は機能を使いこなすことが必要になってきます。

まとめ

今回、はじめてGPTsを作成をしました。日々の業務で困っている「GitHubでのREADME作成やMR作成において時間を節約できる効果的なツール」を作成しました。
※ChatGPT Plus登録が必要

• 作成時間は20分程度

• 対話形式で設定可能

• 要件に特化したGPTsを作成可能

通勤時間にささっと作成できるので是非作ってみてください。

感想

GithubでのREADME作成や先輩へのMRなどに使えるGPTsが簡単に作成できた。時間もかかることなく約20分程あれば自分の問題に合った機能を簡単に追加できました。

今後、ブログでの発信やYoutubeの構成を考えるためのGPTsも作成して発信頻度を高めたいと思いました。

GPTｓの感想や記事の感想などいただけると嬉しいです。

ここまで読んでいただき、ありがとうございます。