Bạn có bao giờ mở một dự án và cảm thấy overwhelmed bởi đống file README dài, todo list rải rác khắp nơi, và không biết bắt đầu từ đâu? Tôi vừa trải qua trải nghiệm đó và tìm ra một cách tổ chức docs/ structure cực kỳ hiệu quả.
1. Vấn đề với cách tổ chức cũ
Trước đây, workspace của tôi trông như thế này:
README.md
dài 500+ dòng chứa mọi thứblog_plan.md
,todolist_fix_blog.md
rải rác- Debug files tạm thời:
debug-simple.js
,debug-simple.mjs
- Không biết tìm thông tin ở đâu khi cần
Kết quả: Mất thời gian tìm kiếm, trùng lặp thông tin, khó maintain.
2. Giải pháp: Docs Structure theo nguyên tắc "Vibe Coding"
2.1 Cấu trúc mới
docs/
├── index.md # 📚 Landing page - mục lục nhanh
├── roadmap/ # 🗺️ Kế hoạch dài hạn
│ └── blog-system.md
├── todo/ # ✅ Việc cần làm theo thời gian
│ ├── 2025-01-blog-rendering.md
│ └── 2025-01-general.md
├── dev/ # 🔍 Debug, development tools
│ └── debugging-blog.md
├── how-to/ # ✍️ Hướng dẫn thực hiện
│ └── writing-posts.md
├── adr/ # 🏗️ Architecture Decision Records
│ └── 001-blog-pipeline-runtime-render.md
├── ops/ # 🚨 Troubleshooting, deployment
│ └── troubleshooting.md
└── styleguide/ # 📝 Code style, conventions
2.2 Nguyên tắc "Một nơi - một sự thật"
Loại thông tin | Nơi lưu trữ | Lý do |
---|---|---|
Kế hoạch tính năng | roadmap/ |
Tầm nhìn dài hạn |
Việc cần làm tuần này | todo/ |
Tracking progress |
Debug commands | dev/ |
Tìm nhanh khi gặp lỗi |
Hướng dẫn làm X | how-to/ |
Onboarding, reference |
Quyết định kỹ thuật | adr/ |
Context cho tương lai |
Lỗi production | ops/ |
Incident response |
3. Lợi ích thực tế
3.1 Tìm kiếm nhanh hơn
Trước: Scroll README 500 dòng tìm debug command
Sau: Mở trực tiếp docs/dev/debugging-blog.md
3.2 Onboarding mới dễ dàng
Thay vì đọc README khổng lồ, người mới chỉ cần:
- Mở
docs/index.md
để có overview - Đọc
docs/how-to/
cho task cụ thể - Check
docs/adr/
để hiểu quyết định kỹ thuật
3.3 Maintenance đơn giản
- Todo: Chỉ update file tuần hiện tại
- Roadmap: Chỉ update khi có thay đổi strategy
- How-to: Update khi process thay đổi
4. Tips triển khai
4.1 Bắt đầu từ đâu?
# Tạo cấu trúc cơ bản
mkdir -p docs/{roadmap,todo,dev,how-to,adr,ops,styleguide}
# Di chuyển files hiện có
mv README_old.md docs/roadmap/
mv todolist.md docs/todo/2025-01-current.md
# Cleanup files tạm thời
rm debug-*.js debug-*.mjs
4.2 Quy tắc đặt tên
- Todo files:
YYYY-MM-topic.md
(ví dụ:2025-01-blog-rendering.md
) - ADR files:
NNN-short-description.md
(ví dụ:001-blog-pipeline-runtime-render.md
) - How-to:
verb-noun.md
(ví dụ:writing-posts.md
,deploying-app.md
)
4.3 Template cho từng loại
Todo template:
# Todo [Topic] - [YYYY MM]
## ✅ Completed
- [x] Task đã hoàn thành
## 🔄 In Progress
- [ ] Task đang làm
## 📋 Pending
- [ ] Task chưa bắt đầu
ADR template:
# ADR-NNN: [Decision Title]
## Context
Tại sao cần quyết định này?
## Decision
Quyết định gì?
## Consequences
Ảnh hưởng gì?
5. Kết quả sau 1 tuần sử dụng
- Thời gian tìm thông tin: Giảm từ 2-3 phút xuống 10-15 giây
- Stress level: Giảm đáng kể khi workspace gọn gàng
- Productivity: Tăng vì focus vào coding thay vì tìm kiếm
- Team collaboration: Dễ chia sẻ context với teammates
Kết luận
Tổ chức docs/ structure không chỉ là việc "dọn dẹp" - nó là investment cho productivity dài hạn. Thay vì có một README khổng lồ chứa mọi thứ, hãy tạo ra một hệ thống tài liệu có cấu trúc, dễ tìm kiếm và maintain.
Key takeaway: Áp dụng nguyên tắc "Một nơi - một sự thật" và "Vibe coding" - vào thẳng file cần thiết, không lãng phí thời gian.
Bạn đã thử tổ chức docs/ structure chưa? Chia sẻ experience của bạn trong comments nhé! 🚀
Bài viết hữu ích?
Chia sẻ để nhiều người biết đến!