book icon indicating copy to clipboard operation
book copied to clipboard

AIエージェントを活用したチュートリアル品質の自動チェック機能の実装

Open suin opened this issue 4 months ago • 0 comments

何をどうしたいか?

TypeScriptチュートリアルの品質を自動的にチェックする仕組みをGitHub Actionsで実装したい:

  1. 定期的な自動チェック(毎日または毎週)
  • AIエージェントが学習者の立場でチュートリアルを読み進め、以下をチェック
    • コードサンプルの動作確認
    • 説明の論理的整合性
    • TypeScript最新バージョンとの互換性
    • 説明とコードの一致
  • 問題点をGitHub Issueとして自動作成
  1. プルリクエスト時の自動チェック
  • チュートリアルコンテンツの変更時に自動実行
  • チェック結果をプルリクエストへコメント

そうしたい理由は何か?

  1. 人的リソースの限界
  • 手動での定期的な全コンテンツレビューは現実的ではない
  • コミュニティからのフィードバックだけでは見落としが発生する可能性
  1. TypeScript/JavaScript環境の急速な進化
  • 言語仕様やベストプラクティスの変化への追従が必要
  • 古い情報や非推奨パターンの早期発見が重要
  1. 学習者体験の継続的な向上
  • 初学者の視点での一貫した品質チェックが必要
  • 説明の分かりやすさや実践的な例示の適切さを保証したい
  1. メンテナンスの効率化
  • 問題の早期発見による修正コストの削減
  • レビュー・更新プロセスの半自動化による負荷軽減

注:AIエージェントを使って定期的に学習者の視点でチュートリアルをチェックすることで、実際のユーザーが問題に遭遇する前に課題を発見し、修正することができます。

着手可能になったら自分でプルリクエストを作成したいか?

他の人でも可(未定)

suin avatar Oct 25 '24 11:10 suin