create-document-skill
Bộ plugin Claude Code sinh tài liệu thiết kế phần mềm có truy vết — từ yêu cầu nghiệp vụ đến cơ sở dữ liệu và API, qua hỏi-đáp tự nhiên.
Ba skill phối hợp theo pipeline hỏi/đáp → spec → DB → API → plan → code (dừng được ở bất kỳ bước nào), cùng chia sẻ một index truy vết liên kết yêu cầu ↔ màn hình ↔ bảng dữ liệu ↔ API.
⚡ Cài đặt
Yêu cầu: đã cài Claude Code. Chạy lần lượt 2 lệnh trong Claude Code.
Bước 1 — thêm marketplace:
/plugin marketplace add https://github.com/lvh149/create-document-skill.git
Bước 2 — cài plugin:
/plugin install spec-writer@spec-writer-marketplace
Sau khi cài, các skill có hiệu lực trên mọi dự án. Bắt đầu bằng cách gõ /spec-writer.
Tính năng
| Skill | Đầu ra | Phạm vi sở hữu |
|---|
| spec-writer | docs/spec/01_requirements.md + docs/spec/screens/F-NNN_*.md | Yêu cầu nghiệp vụ, user story, acceptance criteria, NFR đo được (9 nhóm), RBAC; đặc tả chi tiết từng màn hình (field, validation, flow, message, state transition, responsive/a11y); thiết kế trực quan bằng Claude design |
| db-designer | docs/spec/database/ | Định nghĩa bảng/cột/kiểu dữ liệu, constraint, index, relation, sơ đồ ER (Mermaid), phân loại dữ liệu |
| api-designer | docs/spec/api/ | Thiết kế API 2 tầng (chung + theo resource): request/response JSON, validation khớp ràng buộc DB, error code, route mapping |
Tất cả cập nhật chung docs/spec/00_index.md — nguồn sự thật map F-NNN ↔ màn hình ↔ NFR ↔ bảng ↔ API-ID:
Yêu cầu Màn hình Cơ sở dữ liệu API
F-001 → F-001 → Account → API-001
(spec tổng) (spec con) (bảng) (endpoint)
Nhờ liên kết này, tài liệu dùng trực tiếp để sinh test spec, lập plan và viết code; khi yêu cầu thay đổi, truy ngược được chính xác những tài liệu bị ảnh hưởng.
Cách hoạt động
Pipeline gồm các stage độc lập, dừng được ở bất kỳ stage nào:
| Stage | Việc | Skill |
|---|
| 1 | Khai thác yêu cầu (hỏi-đáp) | superpowers:brainstorming |
| 2 | Spec 2 tầng (yêu cầu + màn hình) | spec-writer |
| 3 | Thiết kế cơ sở dữ liệu | db-designer |
| 4 | Thiết kế API | api-designer |
| 4.5 | Chiến lược & test case từ spec (tùy chọn) | spec-writer · references/test-strategy.md |
| 5 | Lập kế hoạch triển khai | superpowers:writing-plans |
| 6 | Viết code | executing-plans |
Mỗi stage đọc đầu ra của stage trước, nên tài liệu nhất quán và không lặp lại giữa các tầng.
Về phụ thuộc superpowers
Plugin khai báo superpowers là dependency (từ marketplace chính thức claude-plugins-official), nên khi cài plugin này, Claude Code sẽ tự cài kèm superpowers — không cần thao tác thêm.
- Stage 1 (hỏi-đáp) dùng quy trình
brainstorming; Stage 5 dùng writing-plans để lập plan.
- Ba skill lõi (
spec-writer, db-designer, api-designer) sinh tài liệu bằng template của riêng plugin. Nếu vì lý do nào đó superpowers bị tắt, spec-writer vẫn tự hỏi-đáp để ra docs/spec/ (cơ chế dự phòng).
Sử dụng
Tạo spec cho dự án/feature mới (hỏi-đáp → sinh docs/spec/):
/spec-writer
Thiết kế cơ sở dữ liệu từ spec (sinh docs/spec/database/ + sơ đồ ER):
/db-designer
Thiết kế API từ spec và DB (sinh docs/spec/api/):
/api-designer
Ngoài ra có thể gõ yêu cầu tự nhiên, ví dụ:
- "tạo spec cho màn hình login"
- "thêm spec màn hình cho F-002"
- "thiết kế DB từ spec" · "thiết kế API từ spec và DB"
- "thêm trường độ ưu tiên Khẩn cấp vào F-002" — plugin tra
00_index.md, liệt kê các tài liệu bị ảnh hưởng (spec + DB + API) và sửa đồng bộ kèm changelog.
Cập nhật & gỡ cài đặt
Cập nhật lên phiên bản mới:
/plugin marketplace update spec-writer-marketplace
/plugin update spec-writer
Tắt plugin:
/plugin disable spec-writer@spec-writer-marketplace
Gỡ marketplace:
/plugin marketplace remove spec-writer-marketplace
Cấu trúc repo
.
├── .claude-plugin/
│ ├── plugin.json # manifest plugin
│ └── marketplace.json # manifest marketplace
└── skills/
├── spec-writer/ # Stage 2 — spec 2 tầng
│ ├── SKILL.md
│ └── references/ # 8 file: 5 template + design-prompt + cross-doc-checks + test-strategy
├── db-designer/ # Stage 3 — thiết kế CSDL
│ ├── SKILL.md
│ └── references/ # db-design, tech-context, db-rules
└── api-designer/ # Stage 4 — thiết kế API
├── SKILL.md
└── references/ # api-common, api-resource, api-rules
Quy ước
