Viết tài liệu kỹ thuật: API docs, README, changelogs, architecture docs, SOPs, runbooks. Dùng khi: "viết README", "API documentation", "changelog", "architecture doc", "SOP".
| Bạn nói | Tôi sẽ làm |
|---|---|
| "Viết README cho project trading bot" | Full README: overview + setup + usage |
| "Document API endpoint /api/signals" | OpenAPI spec + examples |
| "Viết SOP quy trình deploy lên Coolify" | Step-by-step SOP |
| "Changelog version 2.0.0" | Formatted changelog entry |
Docs tốt = ít support requests. Docs tệ = inbox đầy câu hỏi.
# 📦 [Project Name]
> [1 sentence — project làm gì]
[Optional: badges — build, version, license]
## ✨ Features
- [Feature 1 — giải thích value, not feature name]
- [Feature 2]
- [Feature 3]
## 🚀 Quick Start
### Prerequisites
- [Tool 1] version [X]+
- [Tool 2]
### Installation
\`\`\`bash
git clone https://github.com/[YOUR_GITHUB]/[project].git
cd [project]
npm install
cp .env.example .env
# Edit .env with your values
npm run dev
\`\`\`
### Environment Variables
| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| `API_KEY` | Yes | Gemini API key | `AIza...` |
| `DB_URL` | Yes | PostgreSQL URL | `postgres://...` |
## 📖 Usage
### Basic Example
\`\`\`python
# [Minimal working example]
\`\`\`
### Advanced Example
\`\`\`python
# [Feature showcase]
\`\`\`
## 🏗️ Architecture
\`\`\`
[Simple ASCII diagram]
\`\`\`
## 📁 Project Structure
\`\`\`
project/
├── src/ # Core source
├── tests/ # Test files
├── docs/ # Documentation
├── config/ # Configuration
└── scripts/ # Utility scripts
\`\`\`
## 🤝 Contributing
[How to contribute]
## 📝 License
[License type]
## 👤 Author
**Phạm Phú Nguyễn Hưng** — [Comarai.com](https://comarai.com)
- GitHub: [@[YOUR_GITHUB]](https://github.com/[YOUR_GITHUB])
- Email: [YOUR_EMAIL]
□ Someone can install + run in under 5 minutes?
□ All env variables documented?
□ At least 1 working code example?
□ Architecture diagram (even simple ASCII)?
□ No broken links?
□ Screenshots/demo (if UI)?
□ License specified?
□ Contact/author info?