repo-docs — Tạo và đồng bộ tài liệu repo
Kỹ năng tạo bộ tài liệu Markdown giải thích codebase bắt đầu từ một hành vi thực tế, rồi giữ tài liệu đồng bộ khi code thay đổi.
Lập trìnhTrung cấp★ 456⑂ 6Điểm AI 10/10Cập nhật lần cuối: 12 thg 7, 2026
Làm được gì
- Sinh bộ tài liệu giải thích repo theo một luồng hành vi thật (một request, một task, một luồng dữ liệu) thay vì liệt kê cây thư mục.
- Cấu trúc đầu ra rõ ràng:
README.md,walkthroughs/one-real-run.md,code-map.md,modules/,references/source-evidence.md,glossary.md,change-log.md. - Chọn quy mô gói tài liệu: Standard, Lite hoặc Seed (cho dự án mới chưa có code thật).
- Có "cổng quyết định đồng bộ": mỗi lần bạn hỏi về repo, kỹ năng chọn
none,answer-only,foreground patchhaybackground syncchứ không tự động sửa tài liệu. - Mọi khẳng định phải có bằng chứng từ source/test/config, và cuối cùng chạy
scripts/validate_repo_docs.pyđể kiểm tra cấu trúc, liên kết, bảng bằng chứng. - Chèn khối định tuyến "Repo docs" vào
AGENTS.md/CLAUDE.mdở gốc dự án.
Phù hợp với ai
- Dev, tech lead cần tài liệu onboarding cho thành viên mới.
- Người bảo trì repo mã nguồn mở hoặc nội bộ mà tài liệu thường lệch với code.
- Người vừa nhận một dự án legacy và cần hiểu kiến trúc nhanh.
- Team monorepo muốn giới hạn tài liệu vào một subsystem và nêu rõ phần không bao phủ.
Ví dụ sử dụng
- "Tạo repo-docs cho repo này" → chọn một hành vi tiêu biểu, viết walkthrough theo từng bước, rồi dựng code map và các module khái niệm.
- Sau khi merge một PR lớn: "đồng bộ tài liệu" → chỉ vá trang chủ sở hữu thông tin và ghi
Synced through <sha>vàochange-log.md. - "Luồng xác thực được xử lý ở đâu?" → nếu tài liệu đã đúng thì chỉ trả lời kèm link; nếu tài liệu sai thì vá trang nhỏ nhất rồi trả lời.
- "Xóa toàn bộ repo-docs đã tạo" → dọn gói tài liệu và các con trỏ cũ ở file agent gốc.
· · · Hướng dẫn cài đặt · · ·
Dùng thử ngay, không cần cài
Dán đoạn dưới vào Claude là dùng được skill này mà không cần cài đặt.
Hãy đọc hướng dẫn trong tệp này và làm theo để giúp mình: https://raw.githubusercontent.com/YurunChen/repo-docs-skills/HEAD/docs/SKILL.md Mình muốn: (viết việc bạn cần ở đây)
Nếu Claude không mở được liên kết, hãy mở liên kết và copy nội dung vào rồi dán.
↓ Thấy hữu ích thì tải ZIP bên dưới và cài. Sau đó skill tự chạy, không phải dán lại mỗi lần.
Cài vào ứng dụng Claude (không cần terminal)
- Tải tệp ZIP bằng nút bên dưới.
- Trong Claude, mở Settings → Capabilities và bật 'Code execution and file creation'. (chỉ một lần)
- Vào Customize → Skills → + → 'Upload a skill' rồi tải tệp ZIP lên.
Cài vào Claude Code
Để Claude làm — dán câu dưới đây vào Claude Code
Hãy cài skill mình tìm thấy trên Claude Skill Mart. Copy thư mục docs từ repo GitHub YurunChen/repo-docs-skills vào ~/.claude/skills/repo-docs/ của mình. Sau khi cài xong, cho mình biết skill này làm được gì trong một câu.
Cài bằng lệnh thủ công
git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills && cp -r /tmp/repo-docs-skills/docs ~/.claude/skills/repo-docs⚠ Đây là skill do người khác tạo. Hãy kiểm tra repo gốc trước khi cài.
- Mở terminal.
- Tạo thư mục kỹ năng nếu chưa có:
mkdir -p ~/.claude/skills - Tải repo:
git clone https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-skills - Sao chép thư mục
docsthành kỹ năng:cp -r /tmp/repo-docs-skills/docs ~/.claude/skills/repo-docs - Nếu muốn dùng bản tiếng Trung, sao chép thêm thư mục
repo-docs-zh(nếu có). - Kiểm tra Python:
python3 --version(cần cho script kiểm tra tài liệu). - Khởi động lại Claude Code, mở thư mục repo mục tiêu và yêu cầu: "dùng repo-docs tạo tài liệu cho repo này".
- Sau khi xong, chạy
python scripts/validate_repo_docs.py repo-docs --repo-root .để xác nhận không còn lỗi.