Update docs
プロジェクトドキュメント(repository-overview.md, development-guidelines.md)を最新の状態に更新するFrom its SKILL.md
npx -y skills add idylle-cynique/solo-dev-skills --skill update-docsAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- 27 days oldThe repository was created 27 days ago. New is not bad, but a brand new repository carrying a familiar-sounding name is the shape a typosquat arrives in, and there has been no time for anyone else to find a problem with it.
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its file declares
Copied from the file, not written here
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
4.0 KB, ~1.4k tokens by cl100k_base, as published. Nobody here has run it
以下の手順でプロジェクトドキュメントを最新の状態に更新してください:
1. 更新が必要なドキュメントの特定
以下のドキュメントを確認し、更新が必要かを判断:
.claude/prompts/repository-overview.md- リポジトリ構造概要.claude/prompts/development-guidelines.md- 開発ガイドライン
2. コードベースの変更確認
# 最近の変更を確認
git log --oneline --since="1 week ago"
# 現在のブランチと変更ファイルを確認
git status
# 主要な変更を確認
git diff main...HEAD --stat
3. リポジトリ構造の再調査(repository-overview.md更新時)
以下の観点でコードベースを調査:
- 新しいディレクトリやモジュールの追加
- 主要コンポーネントの変更
- 依存関係の追加・削除(requirements.txt)
- アーキテクチャパターンの変更
- 新しい設定ファイルの追加
調査には Task tool with subagent_type=Explore を使用して、"medium"または"very thorough"レベルで実施。
4. コーディング規約の再分析(development-guidelines.md更新時)
以下の観点でコードベースを分析:
- 新しい命名規則やパターンの追加
- テストパターンの変更
- 新しいエラーハンドリング手法
- コミットメッセージの形式変更(git logから抽出)
- 新しいツールや設定の追加(.pylintrc, mypy.ini等)
5. ドキュメント更新の実施
repository-overview.md の更新箇所:
- ディレクトリ構造: 新規追加/削除されたディレクトリを反映
- 主要コンポーネント: 新しいモジュール、クラス、主要関数の説明追加
- 技術スタック: requirements.txtの変更を反映
- 今後の拡張計画: 完了したPhaseを"完了"とマーク、新しい計画を追加
development-guidelines.md の更新箇所:
- コーディング規約: 新しいパターンやルールの追加
- テスト要件: テストファイルの変更を反映
- コミットメッセージ形式: 最近のコミット履歴から新しい例を追加
- CI/CD設定: .github/workflows/ の変更を反映
- 設定ファイル参照: .pylintrc, mypy.ini等の設定変更を反映
6. 変更内容の確認
更新後、以下を確認:
- マークダウンの文法エラーがないか
- リンク切れがないか
- コード例が正確か
- 最新のファイルパスが正しいか
- 日本語の表記が統一されているか
7. 更新サマリーの報告
以下の形式で更新内容を報告:
## ドキュメント更新サマリー
### repository-overview.md
- [変更内容1]
- [変更内容2]
### development-guidelines.md
- [変更内容1]
- [変更内容2]
### 主な変更理由
- [変更の背景や理由]
8. オプション: 特定のセクションのみ更新
ユーザーが特定のセクションのみの更新を要求した場合:
- 該当セクションのみを調査・更新
- 他のセクションは変更しない
- 更新範囲を明示的に報告
注意事項
- 大規模な変更: リポジトリに大きな変更があった場合(新しいモジュール追加、アーキテクチャ変更等)は、Task toolを使用して徹底的に調査
- 後方互換性: 既存の参照が壊れないように、ファイルパスやセクション構造の変更は慎重に
- 一貫性: 両ドキュメント間で情報の矛盾がないように確認
- 日付の記載: 「最終更新日」などは記載しない(gitで管理されるため)
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.