6.7 KiB
6.7 KiB
RobotNet10 Documentation Hub
📚 Tài liệu dự án / Project Documentation
Chào mừng đến với trung tâm tài liệu của RobotNet10. Tài liệu được tổ chức theo cấu trúc module để dễ dàng tra cứu và bảo trì.
🗂️ Cấu trúc tài liệu / Documentation Structure
1. Architecture
Tài liệu về kiến trúc hệ thống, các thành phần và cách chúng tương tác với nhau.
- System architecture overview
- Component diagrams
- Data flow diagrams
- Communication patterns
- Technology stack details
1.5 ScriptEngine
Tài liệu về module ScriptEngine - shared library cho scripting.
- Web-based C# scripting with Monaco Editor
- Variables, Tasks, and Missions
- State machine and execution flow
- Extension APIs (IScriptResource)
- Used by both RobotApp and FleetManager
2. RobotApp
Tài liệu chi tiết về ứng dụng điều khiển robot.
- Application architecture
- Core features and modules
- Hardware integration
- Navigation and control
- Web interface
- Configuration guide
3. FleetManager
Tài liệu chi tiết về hệ thống quản lý đội xe.
- System architecture
- Fleet coordination logic
- Mission planning and dispatching
- Monitoring and analytics
- Web dashboard
- Configuration guide
4. VDA 5050 Integration
Hướng dẫn triển khai và sử dụng tiêu chuẩn VDA 5050.
- VDA 5050 standard overview
- Message formats and schemas
- MQTT topics structure
- Implementation guidelines
- Testing and validation
- Interoperability considerations
5. Development Guide
Hướng dẫn cho developers tham gia phát triển dự án.
- Development environment setup
- Build and deployment
- Coding standards and conventions
- Testing strategies
- CI/CD pipeline
- Debugging and troubleshooting
- Project Structure & Conventions - Cấu trúc dự án, thư viện, và quy ước đặt tên
- Appccelerate.StateMachine Guide - Hướng dẫn sử dụng thư viện state machine
- Realtime Integration Guide - Tích hợp Linux realtime vào ScriptTask
6. AI Collaboration Guide
Hướng dẫn dành riêng cho AI agents tham gia phát triển dự án.
- Project context and goals
- Key technical decisions
- Code organization principles
- Important patterns and practices
- Common tasks and workflows
🎯 Đối tượng sử dụng / Target Audience
| Tài liệu | Developers | Operators | AI Agents | System Integrators |
|---|---|---|---|---|
| Architecture | ✅ | ⭕ | ✅ | ✅ |
| RobotApp | ✅ | ✅ | ✅ | ✅ |
| FleetManager | ✅ | ✅ | ✅ | ✅ |
| VDA 5050 | ✅ | ⭕ | ✅ | ✅ |
| Development | ✅ | ❌ | ✅ | ⭕ |
| AI Guide | ⭕ | ❌ | ✅ | ❌ |
Legend: ✅ Primary audience | ⭕ Secondary audience | ❌ Not applicable
🚀 Bắt đầu nhanh / Quick Start
⚡ QUICK START GUIDE - Get started in 5-15 minutes!
🗺️ DOCUMENTATION MAP - Find any documentation quickly!
Cho Developers
- Đọc Quick Start Guide để setup nhanh (30-45 phút)
- Xem Development Guide để hiểu chi tiết
- Đọc Architecture Overview để hiểu tổng quan hệ thống
- Chọn module muốn làm việc: RobotApp hoặc FleetManager
Cho AI Agents
- 🤖 Bắt buộc: Đọc AI Collaboration Guide trước tiên (15 phút)
- ⚡ Xem Quick Start Guide cho AI section (5 phút)
- Review Architecture để hiểu context (skim 10 phút)
- Tham khảo module-specific docs khi cần
Cho System Integrators
- Đọc Quick Start Guide - Integrator section
- Đọc VDA 5050 Integration để hiểu giao thức
- Review Architecture để hiểu hệ thống
- Xem RobotApp và FleetManager configuration guides
📝 Quy tắc viết tài liệu / Documentation Guidelines
Mục tiêu Tài liệu / Documentation Goals
Tài liệu trong thư mục docs tập trung vào:
- ✅ Bối cảnh dự án: Vấn đề cần giải quyết, mục tiêu, giải pháp
- ✅ Kiến trúc hệ thống: Cấu trúc tổng thể, các thành phần chính, luồng dữ liệu
- ✅ Ý tưởng thiết kế: Design rationale, quyết định công nghệ, patterns
- ✅ Mermaid diagrams: Sử dụng biểu đồ để minh họa kiến trúc và luồng
- ❌ Không đi chi tiết lập trình: Code examples, API endpoints, implementation details (xem Development Guide)
Ngôn ngữ / Language
- Sử dụng song ngữ Tiếng Việt / English
- Tiêu đề chính bằng cả hai ngôn ngữ
- Nội dung kỹ thuật ưu tiên tiếng Anh (dễ hiểu với AI và developer quốc tế)
- Giải thích concept quan trọng bằng cả hai ngôn ngữ
Cấu trúc / Structure
- Mỗi module có file README.md riêng
- Sử dụng markdown heading hierarchy (H1 > H2 > H3)
- Ưu tiên Mermaid diagrams để minh họa kiến trúc và luồng dữ liệu
- Tránh code examples chi tiết (chỉ khi cần thiết để giải thích concept)
- Links đến related documents
Nội dung / Content
- Rõ ràng: Tránh mơ hồ, mô tả cụ thể
- Bối cảnh: Giải thích "tại sao" không chỉ "như thế nào"
- Kiến trúc: Mô tả cấu trúc và tương tác giữa các thành phần
- Design rationale: Giải thích lý do đằng sau các quyết định thiết kế
- Visual: Sử dụng diagrams (Mermaid) để minh họa concepts
🔄 Cập nhật tài liệu / Documentation Updates
Tài liệu cần được cập nhật khi:
- Thêm feature mới
- Thay đổi architecture
- Update dependencies hoặc technology stack
- Phát hiện lỗi hoặc thiếu sót trong docs
- Thay đổi VDA 5050 implementation
📞 Hỗ trợ / Support
Nếu bạn (human hoặc AI) cần giúp đỡ về tài liệu:
- Check FAQ trong từng section
- Search trong docs bằng từ khóa
- Liên hệ team lead
Last Updated: 2025-11-12 Maintained By: RobotNet10 Development Team