repository-structure
リポジトリ構造定義書を作成するための詳細ガイドとテンプレート。リポジトリ構造定義時にのみ使用。
When & Why to Use This Skill
This Claude skill provides a comprehensive framework and standardized templates for defining and documenting repository structures. It ensures that software projects maintain a clean, maintainable, and consistent directory layout by aligning the physical codebase structure with high-level architectural designs and functional requirements.
Use Cases
- New Project Initialization: Establishing a standardized and logical directory structure at the start of a project to prevent technical debt and disorganized file placement.
- Technical Documentation: Generating a professional 'docs/repository-structure.md' file that serves as a source of truth for the team's file organization conventions.
- Architecture Alignment: Translating high-level system architecture and technology stack decisions into a concrete folder hierarchy.
- Developer Onboarding: Providing a clear map of the repository for new team members to reduce the learning curve and improve development efficiency.
- Refactoring and Standardization: Auditing and restructuring existing repositories to meet modern software engineering best practices and maintainability standards.
| name | repository-structure |
|---|---|
| description | リポジトリ構造定義書を作成するための詳細ガイドとテンプレート。リポジトリ構造定義時にのみ使用。 |
| allowed-tools | Read, Write |
リポジトリ構造定義スキル
このスキルは、明確で保守しやすいリポジトリ構造を定義するための詳細ガイドです。
前提条件
リポジトリ構造定義を開始する前に、以下を確認してください:
必須ドキュメント
docs/product-requirements.md(PRD)docs/functional-design.md(機能設計書)docs/architecture.md(アーキテクチャ設計書)
リポジトリ構造は、アーキテクチャ設計で決定された技術スタックとシステム構成を反映した具体的なディレクトリ構造を定義します。
既存ドキュメントの優先順位
重要: docs/repository-structure.md に既存のリポジトリ構造定義書がある場合、以下の優先順位に従ってください:
既存のリポジトリ構造定義書 (
docs/repository-structure.md) - 最優先- プロジェクト固有のディレクトリ構造が記載されている
- このスキルのガイドより優先する
このスキルのガイド - 参考資料
- 汎用的なテンプレートと例
- 既存定義書がない場合、または補足として使用
新規作成時: このスキルのテンプレートとガイドを参照 更新時: 既存定義書の構造と内容を維持しながら更新
出力先
作成したリポジトリ構造定義書は以下に保存してください:
docs/repository-structure.md
テンプレートの参照
リポジトリ構造定義書を作成する際は、次のテンプレートを使用してください: ./template.md
詳細ガイド
さらに詳しい作成ガイドは次のファイルを参照してください: ./guide.md