Tạo Hướng Dẫn SOP — Hướng Dẫn
Tạo Hướng Dẫn SOP
Phần tiêu đề “Tạo Hướng Dẫn SOP”Tham Khảo Nhanh
- Đối tượng: Technical Writer, Product Manager
- Đầu ra: 1 file
.mdper feature/module- Thời gian: ~5 phút
- Yêu cầu: Project có UI/frontend routes
Yêu Cầu
Phần tiêu đề “Yêu Cầu”- DocKit Master đã cài đặt
- Project có frontend pages/routes hoặc UI components
- Đang ở trong session Google Antigravity
Hướng Dẫn Từng Bước
Phần tiêu đề “Hướng Dẫn Từng Bước”Bước 1: Trigger DocKit Master
Phần tiêu đề “Bước 1: Trigger DocKit Master”Dùng DocKit Master để tạo hướng dẫn SOP cho project tại /path/to/projectBước 2: Chọn Cấu Hình SOP
Phần tiêu đề “Bước 2: Chọn Cấu Hình SOP”| Câu hỏi | Trả lời |
|---|---|
| Loại tài liệu | sop |
| Định dạng output | astro |
| Phạm vi | full hoặc focused |
| Ngôn ngữ | Auto-detect |
Bước 3: Chờ Quét Code
Phần tiêu đề “Bước 3: Chờ Quét Code”Agent sẽ:
- Quét frontend routes/pages
- Phát hiện UI components
- Nhóm features theo module (Miller’s Law: 5-9 items/group)
- Sinh 1 file SOP per feature
Bước 4: Review Output
Phần tiêu đề “Bước 4: Review Output”Mỗi SOP file có cấu trúc chuẩn:
sop/[feature-name].md├── Quick Reference (Who, Where, Time)├── Prerequisites (checklist)├── Step-by-Step Guide (numbered)│ ├── Form field tables│ └── :::tip hints├── Expected Results├── Troubleshooting (<details>)└── FAQ (<details>)Kết Quả Mong Đợi
Phần tiêu đề “Kết Quả Mong Đợi”- ✅
docs/sop/index.md— Feature map + danh sách - ✅
docs/sop/[feature].md— 1 file per feature - ✅ Quick Reference card ở mỗi file
- ✅ Form field tables với real examples
- ✅ Troubleshooting và FAQ trong
<details>
Xử Lý Sự Cố
Phần tiêu đề “Xử Lý Sự Cố”🔴 SOP không có step-by-step guide
Nguyên nhân: Project không có frontend routes hoặc UI components rõ ràng.
Giải pháp: Chỉ định focused scope và tên module cụ thể. Hoặc sử dụng tech docs thay vì sop.
Q: SOP có hỗ trợ screenshot không?
A: DocKit Master tạo placeholder <!-- Screenshot: description -->. Nếu bạn chọn RECORD = yes, Agent sẽ quay browser walkthrough và embedded vào docs.
Xem thêm: Tạo tech docs · Tuỳ chỉnh templates