mirror of
https://github.com/luongnv89/claude-howto.git
synced 2026-08-21 12:17:15 +02:00
Luong NGUYEN
b9a973bf32
Internal accuracy pass against v2.1.220 — no missing upstream features, but broken example code, disagreeing counts, and metadata drift.
Functional fixes: pre-commit.sh now exits 2 so it actually blocks; dependency-check.sh reads file_path from stdin JSON instead of $1; database-mcp.json uses ${DATABASE_URL}; broken fences repaired; three command templates had invalid skill names.
Factual corrections: /fork and /subtask unswapped and /subtask added; /fewer-permission-prompts; permissions.defaultMode; dontAsk/auto unreversed; 31 hook events verified name-by-name; subagent depth 3; skill precedence enterprise > project > personal; /output-style removed not deprecated; permissionDecision gained defer.
Follow-up review fixed defects the pass left behind: zh/vi headers claiming 31 events above 25-name lists, a surviving hardcoded DB credential in the MCP README examples, an unbalanced fence swallowing a metadata footer, and non-canonical tool names. All four translated CATALOG summary tables were recounted so their arithmetic holds.
Full detail in CHANGELOG.md under v2.1.220-r2.
1.9 KiB
1.9 KiB
name: doc-refactor description: プロジェクトドキュメントを再構成して明瞭性とアクセシビリティを高める
ドキュメントリファクタリング
プロジェクトの種類に合わせてドキュメント構造をリファクタリングする:
- プロジェクトを分析: 種類（ライブラリ／API／Web アプリ／CLI／マイクロサービス）、アーキテクチャ、ユーザーペルソナを特定する
- ドキュメントを集約: 技術ドキュメントを
docs/に移動し、適切な相互参照を整える - ルート README.md: 概要、クイックスタート、モジュール／コンポーネントのサマリ、ライセンス、連絡先を含むエントリーポイントとして整理する
- コンポーネント別ドキュメント: モジュール／パッケージ／サービス単位の README ファイルを追加し、セットアップとテスト手順を記載する
docs/を関連カテゴリで整理する:- Architecture、API Reference、Database、Design、Troubleshooting、Deployment、Contributing（プロジェクトの必要に応じて調整）
- ガイドを作成する（該当するものを選ぶ）:
- User Guide: アプリケーションのエンドユーザー向けドキュメント
- API Documentation: API のエンドポイント、認証、サンプル
- Development Guide: セットアップ、テスト、コントリビューションのワークフロー
- Deployment Guide: サービス／アプリの本番デプロイ
- すべての図に Mermaid を使う（アーキテクチャ、フロー、スキーマ）
ドキュメントは簡潔に、流し読みしやすく、プロジェクトの種類に即した内容に保つ。
Last Updated: April 9, 2026