name: reorganize-docs description: Reorganize project documentation with bilingual (English/Japanese) structure. Use when asked to "reorganize docs", "update documentation", or "sync documentation".
Reorganize Docs
Reorganize and synchronize project documentation with proper bilingual structure.
Documentation Structure
/
├── AGENTS.md # Claude Code guidance (English)
├── README.md # Project introduction (English)
└── docs/
├── AGENTS.ja.md # Claude Code guidance (Japanese)
├── README.ja.md # Project introduction (Japanese)
├── DEVELOPMENT.md # Development guide (English)
└── DEVELOPMENT.ja.md # Development guide (Japanese)
File Purposes
| File | Purpose |
|---|---|
AGENTS.md |
Claude Code guidance: overview, commands |
README.md |
Project intro: quickstart, prerequisites |
docs/DEVELOPMENT.md |
Detailed dev guide: services, troubleshooting |
Cross-link Format
English files: Add after the title heading
[🇯🇵 日本語版](path/to/file.ja.md)
Japanese files: Add after the title heading
[🇺🇸 English](path/to/file.md)
Cross-link Paths
| English File | Japanese File |
|---|---|
AGENTS.md |
docs/AGENTS.ja.md |
README.md |
docs/README.ja.md |
docs/DEVELOPMENT.md |
docs/DEVELOPMENT.ja.md |
English files link to Japanese with [🇯🇵 日本語版](path/to/file.ja.md).
Japanese files link to English with [🇺🇸 English](path/to/file.md).
AGENTS.md Content Requirements
- Project Overview: Purpose and architecture
- Development Commands: Just commands with descriptions
- Directory Structure: Minimal monorepo structure
- GitHub Secrets: Required secrets for CI/CD
- Key Technical Decisions: Stack and tooling choices
README.md Content Requirements
- Project Title and Description
- Prerequisites: Homebrew, mise, pnpm
- Quick Start: Bootstrap and dev commands
- Documentation Links: Links to detailed docs
- License
Workflow
- Read existing documentation files
- Read
justfileto extract command documentation - Read
.github/workflows/to extract required GitHub Secrets - Generate English
AGENTS.mdwith all required sections - Generate English
README.md - Create
docs/directory if not exists - Generate Japanese translations (
*.ja.md) - Add cross-links to all files
- Remove old
DEVELOPMENT.mdfrom root (if moved to docs/) - Run
prek run -ato verify all linting passes
Translation Guidelines
- Keep code blocks, commands, file paths, and URLs as-is
- Translate prose content naturally
- Maintain consistent terminology
- Keep table structure identical
- Preserve markdown formatting
Emoji Guidelines
ドキュメント作成時は絵文字を積極的に使用する:
- 📋 セクション見出しに絵文字を追加
- ✅ リストアイテムや完了項目
- ⚠️ 警告や注意事項
- 💡 Tips やヒント
- 🔧 設定・コマンド関連
- 📁 ファイル・ディレクトリ
- 🚀 Quick Start・Getting Started
- 📖 ドキュメントリンク
- ⚡ パフォーマンス・最適化
- 🔒 セキュリティ関連
Verification
After completion, run:
prek run -a
All checks must pass before considering the task complete.