Claude_Code_の_Skills_を使った_ドキュメント運用__BLGRadio用__-_Google_スライド.pdf

Transcript

1. Claude Code Skills を 使ったドキュメント運⽤
2. Agenda 01 ⾃⼰紹介 02 ドキュメント運⽤の課題 03 AI に任せてみた 04 今後の展望‧まとめ 2
3. 01 ⾃⼰紹介
4. ⾃⼰紹介 About me 2024/12/01 ~ Belong join サウナが好き Role フルスタックエンジニア Skills Python Go mani (Masato Ohinata) Security
5. 02 ドキュメント運⽤の課題
6. ドキュメントを⾒ていて思うこと • ⾒たい情報がのっているページがない！ • この情報は正確なのか‧‧？ • このページは更新されているのか？ ↓ ドキュメントの運⽤が難しいから発⽣している
7. ドキュメントの運⽤ 主に 新規作成 と 更新 • 新機能の実装 ⇨新規ページとして作成していく • 既存機能の仕様変更 ⇨既存ページの内容を更新していく • サービスのドメイン知識を書き留める ⇨新規ページとして作成し、仕様変更があれば更新する
8. ドキュメントの作成‧更新について 適切な ドキュメントの作成‧更新が必要なタイミング とは？ A. 新しいバージョンがリリースされたタイミング 理由 リリースされていないのにドキュメントに反映はできない ⇨リリースタイミングで⼀気に更新する必要がある ⇨ドキュメント運⽤は結構⼤変
9. 03 AI に任せてみた
10. ドキュメント運⽤は AI に任せられそう？ • 新規作成（1機能1ページ） • AI の⽣成する⽂章は結構怪しい • 過情報になったり間違った内容になりがち ⇨AI に任せるのはまだ早い • 更新（1リリースnページ） • ベースがある状態での軽微修正ならできそう？ • 修正するページの洗い出しなら AI は得意そう ⇨AI に任せられそう！
11. AI がドキュメントを新規作成できない理由 AI がドキュメントを書くときに参照するもの • ソースコード • 既存のドキュメント ↓ 独⾃のドメイン知識が 反映されない / 表現がズレる ⽣成する⽂章がそれっぽいものを出すので、いい感じに⾒えるが、よくみたら ミスリードな⽂章になっている ⇨⾎の通っていない⽂章 になる
12. 課題解決のために作成した Skills • 更新すべき Notion ページの特定 • コードから更新内容の⽣成 • レビュー画⾯にて更新前後の表⽰
13. 処理の流れ
15. 更新を任せてみて得られたこと • ドキュメントの軽い更新程度なら AI でも問題はない • ⽣成する⽂章は怪しいことが多いのでレビューは必須 • リリースのたびに発⽣する作業の負担の軽減には成功している • ⼈間の作業にありそうな記⼊漏れが起きないのでいい運⽤⽅法だ と思っている
16. 04 今後の展望‧まとめ
17. 新規作成もできるようにしたい • AI にお願いすると1ページが膨⼤になったりする • 余計な⽂章や変な⾔い回し • 「AI には書けない」のではなく 「書き⽅のプロンプトを渡していない」だけかもしれない • AI が⾎の通った⽂章をかけるプロンプト‧Skills が必要 • ドキュメントの書き⽅の情報も必要
18. まとめ • 更新はもう AI に任せられている • 新規作成が難しいのは、AI の限界ではなく 書き⽅の規範を渡していないからではないか？ • いい Skills を育てて、ドキュメンテーションの AI 化を ⽬指していきたい
19. 新規作成の Skills を作る場合 • 材料：書き⼿にインタビューして引き出す • 対象 / ⽬的 / 読者 / 種別 / 範囲 / 材料 / 配置先 • コードにも既存ドキュメントにも無い情報を引き出す • プロンプト：書き⽅のルールを同梱する • テクニカルライティングの知⾒ • ⽇本語をきちんと記述するSkills • 既存ドキュメントの踏襲（デザイン等）