Tài liệu dự án
Cách lập tài liệu cho một dự án để người khác có thể hiểu, tái lập và tiếp tục phát triển nó.
Một trang dự án tốt bao gồm
- Mục tiêu — bài toán và mục tiêu cần đạt
- Đội ngũ & vai trò
- Kiến trúc hệ thống — sơ đồ khối phần cứng + phần mềm
- Danh mục vật tư (Bill of materials) — phần cứng/linh kiện chính
- Hướng dẫn thiết lập & build
- Kết quả — số liệu đo, hình ảnh, video/demo
- Liên kết — GitHub, bài báo, demo
- Bước tiếp theo / các vấn đề đã biết
Mẫu (Template)
Sao chép cấu trúc này vào một file mới trong dự án của bạn và điền nội dung vào. Đặt sơ đồ và hình ảnh gần phần liên quan. Các dự án công khai được giới thiệu trên trang Dự án.