Files
claude-howto/vi/01-slash-commands/doc-refactor.md
T
Luong NGUYEN b9a973bf32 docs: accuracy pass against Claude Code v2.1.220 (#155)
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.
2026-08-04 15:41:12 +07:00

1.4 KiB

name, description
name description
doc-refactor Cấu trúc lại tài liệu dự án để rõ ràng và dễ truy cập

Documentation Refactor

Refactor cấu trúc tài liệu dự án được điều chỉnh theo loại dự án:

  1. Phân tích dự án: Xác định loại (library/API/web app/CLI/microservices), kiến trúc, và personas người dùng
  2. Tập trung tài liệu: Chuyển tài liệu kỹ thuật vào docs/ với các tham chiếu chéo phù hợp
  3. README.md gốc: Đơn giản hóa như điểm vào với tổng quan, bắt đầu nhanh, tóm tắt modules/components, giấy phép, liên hệ
  4. Tài liệu component: Thêm các file README module/package/service-level với hướng dẫn thiết lập và testing
  5. Tổ chức docs/ theo các danh mục phù hợp:
    • Architecture, API Reference, Database, Design, Troubleshooting, Deployment, Contributing (điều chỉnh theo nhu cầu dự án)
  6. Tạo hướng dẫn (chọn cái phù hợp):
    • User Guide: Tài liệu người dùng cuối cho các ứng dụng
    • API Documentation: Các endpoints, xác thực, ví dụ cho APIs
    • Development Guide: Thiết lập, testing, workflow đóng góp
    • Deployment Guide: Triển khai production cho các dịch vụ/ứng dụng
  7. Sử dụng Mermaid cho tất cả các sơ đồ (architecture, flows, schemas)

Giữ tài liệu ngắn gọn, dễ quét, và phù hợp với loại dự án.