258 lines
6.6 KiB
Markdown
258 lines
6.6 KiB
Markdown
# [Guide Title] / [Tiêu đề Hướng dẫn]
|
|
|
|
> **EN**: Brief English description of what this guide covers
|
|
> **VI**: Mô tả ngắn gọn bằng tiếng Việt về nội dung hướng dẫn này
|
|
|
|
## Workflow Diagram / Sơ đồ Quy trình
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
Start([Start]) --> Check{Prerequisites<br/>Met?}
|
|
Check -->|No| Install[Install Prerequisites]
|
|
Check -->|Yes| Step1[Step 1: Action]
|
|
Install --> Step1
|
|
Step1 --> Step2[Step 2: Action]
|
|
Step2 --> Step3[Step 3: Action]
|
|
Step3 --> Verify{Verify<br/>Success?}
|
|
Verify -->|No| Troubleshoot[Check Troubleshooting]
|
|
Verify -->|Yes| End([Complete])
|
|
Troubleshoot --> Step1
|
|
|
|
style Start fill:#e1f5ff
|
|
style End fill:#d4edda
|
|
style Check fill:#fff3cd
|
|
style Verify fill:#fff3cd
|
|
```
|
|
|
|
## Prerequisites / Yêu cầu
|
|
|
|
### EN: Requirements
|
|
|
|
Before starting this guide, ensure you have:
|
|
- Requirement 1 with specific version (e.g., Node.js 20+)
|
|
- Requirement 2
|
|
- Requirement 3
|
|
|
|
### VI: Yêu cầu
|
|
|
|
Trước khi bắt đầu hướng dẫn này, hãy đảm bảo bạn có:
|
|
- Yêu cầu 1 với phiên bản cụ thể (ví dụ: Node.js 20+)
|
|
- Yêu cầu 2
|
|
- Yêu cầu 3
|
|
|
|
**Quick Check / Kiểm tra nhanh**:
|
|
```bash
|
|
# EN: Verify prerequisites / VI: Xác minh yêu cầu
|
|
node --version # Should be 20 or higher / Phải là 20 hoặc cao hơn
|
|
docker --version # Should be installed / Phải được cài đặt
|
|
```
|
|
|
|
## Overview / Tổng quan
|
|
|
|
### EN: What You'll Learn
|
|
|
|
By the end of this guide, you will be able to:
|
|
1. Outcome 1
|
|
2. Outcome 2
|
|
3. Outcome 3
|
|
|
|
**Estimated Time / Thời gian ước tính**: X minutes
|
|
|
|
### VI: Bạn Sẽ Học Được Gì
|
|
|
|
Khi hoàn thành hướng dẫn này, bạn sẽ có thể:
|
|
1. Kết quả 1
|
|
2. Kết quả 2
|
|
3. Kết quả 3
|
|
|
|
**Estimated Time / Thời gian ước tính**: X phút
|
|
|
|
## Step-by-Step Guide / Hướng dẫn Từng bước
|
|
|
|
### Step 1 / Bước 1: [Action Title]
|
|
|
|
**EN**: English explanation of what this step accomplishes and why it's necessary.
|
|
|
|
**VI**: Giải thích tiếng Việt về những gì bước này đạt được và tại sao nó cần thiết.
|
|
|
|
```bash
|
|
# EN: Command description / VI: Mô tả lệnh
|
|
command-here --flag value
|
|
|
|
# EN: Expected output / VI: Kết quả mong đợi
|
|
Success message or output
|
|
```
|
|
|
|
**Important Notes / Ghi chú quan trọng**:
|
|
- Note 1 / Ghi chú 1
|
|
- Note 2 / Ghi chú 2
|
|
|
|
**File to Create / File cần tạo**:
|
|
```bash
|
|
# EN: Create configuration file / VI: Tạo file cấu hình
|
|
touch .env.local
|
|
```
|
|
|
|
**Example Content / Nội dung ví dụ**:
|
|
```env
|
|
# EN: Environment variables / VI: Biến môi trường
|
|
PORT=5000
|
|
NODE_ENV=development
|
|
DATABASE_URL=postgresql://localhost:5432/mydb
|
|
```
|
|
|
|
### Step 2 / Bước 2: [Action Title]
|
|
|
|
**EN**: Continue with next step explanation...
|
|
|
|
**VI**: Tiếp tục với giải thích bước tiếp theo...
|
|
|
|
```typescript
|
|
// EN: Code example for this step
|
|
// VI: Ví dụ code cho bước này
|
|
import { Example } from './example';
|
|
|
|
const instance = new Example();
|
|
await instance.initialize();
|
|
```
|
|
|
|
**Expected Result / Kết quả mong đợi**:
|
|
- ✅ Result 1 / Kết quả 1
|
|
- ✅ Result 2 / Kết quả 2
|
|
|
|
### Step 3 / Bước 3: [Action Title]
|
|
|
|
(Continue pattern for each step)
|
|
|
|
## Verification / Xác minh
|
|
|
|
**EN**: How to verify that everything is working correctly.
|
|
|
|
**VI**: Cách xác minh mọi thứ đang hoạt động chính xác.
|
|
|
|
### Quick Test / Kiểm tra nhanh
|
|
|
|
```bash
|
|
# EN: Run verification command / VI: Chạy lệnh xác minh
|
|
curl http://localhost:5000/health
|
|
|
|
# EN: Expected response / VI: Phản hồi mong đợi
|
|
{"status":"ok","timestamp":"2024-01-01T00:00:00.000Z"}
|
|
```
|
|
|
|
### Verification Checklist / Danh sách kiểm tra
|
|
|
|
- [ ] Check 1 / Kiểm tra 1: Description / Mô tả
|
|
- [ ] Check 2 / Kiểm tra 2: Description / Mô tả
|
|
- [ ] Check 3 / Kiểm tra 3: Description / Mô tả
|
|
|
|
## Common Issues / Vấn đề Thường gặp
|
|
|
|
### Issue 1: [Problem Description]
|
|
|
|
**EN Symptoms**: What you see when this problem occurs
|
|
|
|
**VI Triệu chứng**: Những gì bạn thấy khi vấn đề này xảy ra
|
|
|
|
**EN Solution**:
|
|
```bash
|
|
# Steps to fix
|
|
step-1
|
|
step-2
|
|
```
|
|
|
|
**VI Giải pháp**:
|
|
```bash
|
|
# Các bước để sửa
|
|
step-1
|
|
step-2
|
|
```
|
|
|
|
### Issue 2: [Problem Description]
|
|
|
|
(Repeat pattern for common issues)
|
|
|
|
## Troubleshooting Decision Tree / Cây Quyết định Khắc phục
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Problem[Problem Occurs] --> Check1{Check 1:<br/>Condition?}
|
|
Check1 -->|Yes| Solution1[Solution 1]
|
|
Check1 -->|No| Check2{Check 2:<br/>Condition?}
|
|
Check2 -->|Yes| Solution2[Solution 2]
|
|
Check2 -->|No| Check3{Check 3:<br/>Condition?}
|
|
Check3 -->|Yes| Solution3[Solution 3]
|
|
Check3 -->|No| Support[Contact Support]
|
|
|
|
Solution1 --> Resolved{Resolved?}
|
|
Solution2 --> Resolved
|
|
Solution3 --> Resolved
|
|
Resolved -->|No| Support
|
|
Resolved -->|Yes| Success([Success])
|
|
```
|
|
|
|
## Advanced Options / Tùy chọn Nâng cao
|
|
|
|
**EN**: Optional advanced configurations or alternative approaches.
|
|
|
|
**VI**: Cấu hình nâng cao tùy chọn hoặc cách tiếp cận thay thế.
|
|
|
|
### Option 1 / Tùy chọn 1: [Title]
|
|
|
|
**EN**: When to use this option and how to implement it.
|
|
|
|
**VI**: Khi nào sử dụng tùy chọn này và cách triển khai.
|
|
|
|
```bash
|
|
# Example command
|
|
advanced-command --option
|
|
```
|
|
|
|
## Next Steps / Bước Tiếp theo
|
|
|
|
**EN**: What to do after completing this guide.
|
|
|
|
**VI**: Làm gì sau khi hoàn thành hướng dẫn này.
|
|
|
|
- [ ] Next step 1 / Bước tiếp theo 1: [Related Guide](../guides/related-guide.md)
|
|
- [ ] Next step 2 / Bước tiếp theo 2: [Another Guide](../guides/another-guide.md)
|
|
- [ ] Next step 3 / Bước tiếp theo 3: [Deep Dive](../skills/deep-dive.md)
|
|
|
|
## Additional Resources / Tài nguyên Bổ sung
|
|
|
|
### Related Documentation / Tài liệu Liên quan
|
|
|
|
- [Related Guide 1](../guides/guide-1.md) - EN: Description / VI: Mô tả
|
|
- [Related Architecture](../architecture/arch-doc.md) - EN: Description / VI: Mô tả
|
|
- [Related Skill](../skills/skill-doc.md) - EN: Description / VI: Mô tả
|
|
|
|
### External Resources / Tài nguyên Bên ngoài
|
|
|
|
- [Official Documentation](https://example.com) - EN: What it covers
|
|
- [Tutorial](https://example.com) - EN: Video or article description
|
|
|
|
## FAQ / Câu hỏi Thường gặp
|
|
|
|
### EN: Question 1?
|
|
|
|
Answer 1 in English.
|
|
|
|
### VI: Câu hỏi 1?
|
|
|
|
Câu trả lời 1 bằng tiếng Việt.
|
|
|
|
### EN: Question 2?
|
|
|
|
Answer 2 in English.
|
|
|
|
### VI: Câu hỏi 2?
|
|
|
|
Câu trả lời 2 bằng tiếng Việt.
|
|
|
|
---
|
|
|
|
**Last Updated / Cập nhật lần cuối**: YYYY-MM-DD
|
|
**Difficulty / Độ khó**: Beginner/Intermediate/Advanced
|
|
**Estimated Time / Thời gian ước tính**: X minutes
|
|
**Authors / Tác giả**: Your Name
|