← Back to list

reorganize-docs
by tqer39
Personal blog monorepo powered by Next.js, Hono, and Cloudflare.
⭐ 0🍴 0📅 Jan 25, 2026
SKILL.md
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
/
├── CLAUDE.md # Claude Code guidance (English)
├── README.md # Project introduction (English)
└── docs/
├── CLAUDE.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 |
|---|---|
CLAUDE.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 |
|---|---|
CLAUDE.md | docs/CLAUDE.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).
CLAUDE.md Content Requirements
CLAUDE.md は簡潔に保ち、他ドキュメントで参照可能な内容は削除する。
含めるべき内容
- Blog Philosophy: このリポジトリ固有の設計思想
- Project Overview: 概要と他ドキュメントへの参照リンク
- Environment Configuration: 3 環境構成図
- Release Flow: CI/CD フロー図
- Authentication: 認証方式
- Package Names: パッケージ名一覧
- Key Technical Decisions: 技術選定
- Deployment: デプロイ情報(概要のみ)
- Tool Management: ツール管理(簡潔に)
他ドキュメントへ委譲する内容
| 内容 | 参照先 |
|---|---|
| 開発コマンド | just --list |
| ディレクトリ構造 | README.md |
| GitHub Secrets | docs/SECRETS.md |
| CI/CD ワークフロー詳細 | .github/workflows/ |
簡潔化ルール
- 冗長な記述は削除し、参照リンクを記載
- コマンド一覧は
just --listで確認可能なため詳細不要 - テーブルは必要最小限の列のみ
- 重複を避け、Claude Code に必要な情報のみを記載
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
CLAUDE.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
Verification
After completion, run:
prek run -a
All checks must pass before considering the task complete.
Score
Total Score
65/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon


