mcpField
F
folder-organization

folder-organization

github.com/delphine-l開発22148 回インストール24 週間前に更新
リポジトリ

folder-organization について

研究・開発プロジェクトのディレクトリ整理、ファイル命名、見通しのよい構成を支援するガイドスキルです。プロジェクト別の構成例に加え、バージョン管理、再編、文書整備の手順を示します。

主な機能

  1. 01研究・開発向け構成の提案
  2. 02ファイルとディレクトリの命名規則
  3. 03生データ・加工済み・外部データの分離
  4. 04バージョン管理と除外設定の指針
  5. 05再編と非推奨化の手順
  6. 06文書とマニフェストの整理

活用シーン

  1. 01新しい研究プロジェクトの構成作成
  2. 02既存コードベースの再編
  3. 03チーム内のファイル命名統一
  4. 04生成物や非推奨ファイルの整理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/delphine-l/claude_global --skill folder-organization

インストール後、Claude Code で/folder-organizationを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

deprecation-guide.md
documentation-organization.md
manifest-system.md
naming-conventions.md
project-structures.md
reorganization-guide.md

詳細

フォルダー構成のベストプラクティス

プロジェクトディレクトリの整理、ファイル命名規則の確立、研究開発作業に適した、整然として移動しやすいプロジェクト構造の維持に関する専門的なガイダンスです。

このスキルを使用するタイミング

  • 新しいプロジェクトを立ち上げるとき
  • 既存のプロジェクトを再編成するとき
  • チームの規約を定めるとき
  • 再現可能な研究用の構成を作成するとき
  • データ量の多いプロジェクトを管理するとき

基本原則

  1. 予測可能性 - 一般的なファイル形式に標準の配置場所を設けます
  2. 拡張性 - プロジェクトの成長に合わせて構造を無理なく拡張できるようにします
  3. 関心事の分離 - コード、データ、ドキュメント、出力を分けます
  4. 見つけやすさ - 他の人（そして将来の自分）が簡単に構造を把握できるようにします
  5. バージョン管理との相性 - サイズの大きいファイルや生成ファイルを適切に除外します

クイックリファレンス：標準的なプロジェクト構成

プロジェクトの種類に合った構成を使用してください。テンプレート全体は project-structures.md にあります。

研究／分析：data/{raw,processed,external}、notebooks/、src/、scripts/、tests/、docs/、results/、config/

開発：src/package_name/、tests/、docs/、examples/、.github/workflows/

バイオインフォマティクス：data/{raw,reference,processed}、workflows/、config/、scripts/、results/、logs/

ノートブックを使ったデータ分析：notebooks/、figures/、data/、tests/、scripts/、docs/、archives/

効率よく移動できるように、MANIFEST.md ファイルを追加してください（manifest-system.md を参照）。

ファイル命名規則

詳しい規約は naming-conventions.md にあります。主なルールは次のとおりです。

  1. 小文字を使う。ハイフンまたはアンダースコアで区切り、スペースやキャメルケースは使いません
  2. 説明的かつ簡潔にする - script.py ではなく process-telomere-data.py のようにします
  3. 区切り文字を統一する - ファイルにはハイフン、Python モジュールにはアンダースコアを使います
  4. 重要な出力にはバージョン／日付を含める - report-2026-01-23.pdf
  5. 連番はゼロ埋めする - 01-exploration.ipynb、02-analysis.ipynb
  6. session-saves/ ディレクトリ内のセッションノートの形式を統一します

バージョン管理

コミットするもの：ソースコード、ドキュメント、設定ファイル、小さなテストデータ（<1MB）、要件ファイル、README

コミットしないもの：サイズの大きいデータファイル、生成された出力、環境ディレクトリ、ログ、一時ファイル、API キー／シークレット

.gitignore テンプレート
# Claude Code
.claude/

# Python
__pycache__/
*.py[cod]
.venv/
venv/

# Jupyter
.ipynb_checkpoints/

# Data
data/raw/
data/processed/
*.fastq.gz
*.bam

# Outputs
results/
outputs/
*.png
*.pdf

# Logs & Environment
logs/
*.log
.env
.DS_Store

データの整理

  • 生データは決して変更しないでください - 元データは data/raw/ に保管してください（可能であれば読み取り専用にします）
  • データの来歴（取得元、ダウンロード日）を記録します
  • 次の階層を使用します：raw/ -> interim/ -> processed/ -> external/

よくあるアンチパターン

次のパターンは避けてください：

  • フラットな構成：整理されておらず、すべてのファイルがルートディレクトリにある
  • 曖昧な命名：notebook1.ipynb、test.ipynb、analysis_new.ipynb
  • 関心事の混在：src/ ディレクトリにデータファイルや出力画像を置く

非推奨化の方針

履歴と復旧手段を維持するため、削除するのではなく非推奨として扱います。詳しいガイドは deprecation-guide.md にあります。

主な手順：

  1. 説明的な名前の deprecated/ サブディレクトリを作成します
  2. 古いファイルをそこへ移動します
  3. 対象、時期、理由、復旧方法を説明する README.md を作成します
  4. 非推奨のディレクトリが複数に散在している場合は、ルートの deprecated/ に集約します

プロジェクトの再編成

体系的なガイド全体は reorganization-guide.md にあります。重要な手順は次のとおりです。

  1. ファイルを移動した後、スクリプトとノートブック内のすべてのファイルパスを更新します
  2. 参照箇所を検索します：grep -r "\.json\|\.csv\|\.png" --include="*.ipynb" --include="*.py"
  3. ファイル数を確認し、想定どおりか（ファイルが失われていないか）確かめます
  4. 一時ファイル（.bak、.ipynb_checkpoints）を削除します
  5. ノートブック／スクリプトが引き続き正しく実行されることをテストします

ドキュメントの基準

詳しいガイドは documentation-organization.md にあります。主なポイントは次のとおりです。

  • すべてのプロジェクトに、説明、インストール方法、使い方、構成、データ、結果を記載した README が必要です
  • 大きな変更の後には、日付入りの概要ドキュメントを作成します
  • 散在するドキュメントを documentation/ ディレクトリに集約します
  • プロジェクトのルートには README.md、LICENSE、.gitignore のみを置きます

MANIFEST System

トークン効率に優れたプロジェクトナビゲーションシステムです。詳しくは manifest-system.md をご覧ください。

  • セッション開始時のトークンを85～90％削減します
  • ルートの MANIFEST.md で、約1,500トークンの完全なプロジェクト概要を確認できます
  • data/、figures/、scripts/、documentation/ にサブディレクトリ用の MANIFEST を用意します
  • 各セッションの終了時に /update-manifest で更新します

プロジェクトの整理：必須ファイルの特定

詳しい手順は deprecation-guide.md の「Project Cleanup」セクションをご覧ください。概要：

  1. ノートブックを分析して、参照されている図を特定します
  2. 図と生成スクリプトの対応関係を確認します
  3. 未使用ファイルを、内容がわかるサブディレクトリ名を付けて deprecated/ に移動します
  4. 残したファイルを MINIMAL_ESSENTIAL_FILES.md に記録します
  5. 整理後の構成でもノートブックが動作することを確認します

他のスキルとの連携

  • python-environment - 環境のセットアップと管理
  • claude-collaboration - チームのワークフローに関するベストプラクティス
  • jupyter-notebook-analysis - ノートブックの整理基準
  • data-backup - バックアップシステムに MANIFEST を含めます
  • project-sharing - 共有パッケージに MANIFEST を含めます

クイックセットアップ

# Create standard research project structure
mkdir -p data/{raw,processed,external} notebooks scripts src tests docs results config
touch README.md .gitignore environment.yml

補足ファイル

ファイル内容
project-structures.mdすべてのプロジェクトタイプに対応した、詳細なディレクトリテンプレート
naming-conventions.mdファイル名の規則やパターン、セッションノートの保存方法
reorganization-guide.md再編成、パスの更新、検証の手順
deprecation-guide.md非推奨化の方針、統合、必須ファイルの特定
documentation-organization.mdドキュメントの基準、変更概要、ドキュメントディレクトリの構成
manifest-system.mdMANIFEST システムの全容：テンプレート、コマンド、ワークフロー、ベストプラクティス

参考資料

コメント

Markdown 対応