BQP/docs/DOCUMENTATION_MAP.md

Documentation Map / Bản đồ Tài liệu

🗺️ Quick Navigation / Điều hướng Nhanh

Tài liệu này giúp bạn tìm nhanh tài liệu cần thiết cho từng vai trò và nhiệm vụ cụ thể.

👥 By Role / Theo Vai trò

🤖 For AI Agents

Start here: AI Collaboration Guide ⭐ REQUIRED READING

Essential documents:

1. AI Guide - How to work on this project ⭐ REQUIRED
2. Architecture Overview - System design
3. FleetManager Docs - Core modules overview
   • Identity Module
   • MapEditor Module
   • RobotConnections Module
   • RobotManager Module
   • TrafficControl Module
   • ScriptEngine Module
   • FleetManagerConfig Module
4. ScriptEngine Docs - Shared scripting library
5. MapEditor Docs - Shared map editor library
6. VDA 5050 Integration - Protocol details

Then choose based on task:

• Working on robot: RobotApp Docs
• Working on fleet manager: FleetManager Docs
• Setting up environment: Development Guide

👨‍💻 For Developers (Human)

Start here: Development Guide

Recommended reading order:

1. Project README - Project overview
2. Development Guide - Setup environment
3. Architecture Overview - Understand system
4. Choose component:
   • RobotApp Docs
   • FleetManager Docs
5. VDA 5050 Integration - Protocol implementation

👷 For System Integrators

Start here: Architecture Overview

Essential documents:

1. Architecture Overview - System architecture
2. VDA 5050 Integration - Integration protocol
3. RobotApp Docs - Robot-side details
4. FleetManager Docs - Server-side details

🎓 For Learning

Start here: Project README

Learning path:

1. Project README - What is RobotNet10?
2. Architecture Overview - How does it work?
3. VDA 5050 Integration - What is VDA 5050?
4. Development Guide - How to develop?

📋 By Task / Theo Nhiệm vụ

Task: Implement VDA 5050 Feature

Primary docs:

• VDA 5050 Integration - Protocol spec
• AI Guide - Implementation patterns

Related docs:

• RobotApp or FleetManager - Where to implement

Task: Develop RobotApp Feature

Primary docs:

• RobotApp Documentation
• Development Guide

Related docs:

• Architecture Overview - System context
• VDA 5050 Integration - If feature involves communication

Task: Develop FleetManager Feature

Primary docs:

• FleetManager Documentation
• Development Guide

Related docs:

• Architecture Overview - System context
• VDA 5050 Integration - If feature involves communication

Task: Setup Development Environment

Primary docs:

• Development Guide
• Project Structure & Conventions - Project structure, libraries, naming conventions
• Appccelerate.StateMachine Guide - State machine library usage

Task: Understand System Architecture

Primary docs:

• Architecture Overview

Related docs:

• RobotApp Documentation
• FleetManager Documentation

Task: Debug MQTT/VDA 5050 Issues

Primary docs:

• VDA 5050 Integration

Related docs:

• Development Guide - Debugging section
• RobotApp or FleetManager - Troubleshooting

Task: Write Tests

Primary docs:

• Development Guide - Testing section
• AI Guide - Testing patterns

Task: Deploy Application

Primary docs:

• Development Guide - Deployment section

Related docs:

• RobotApp Documentation - RobotApp deployment
• FleetManager Documentation - FleetManager deployment

📚 All Documents / Tất cả Tài liệu

Core Documentation

Document	Description	Audience
README.md	Project overview	Everyone
docs/README.md	Documentation hub	Everyone
DOCUMENTATION_MAP.md	This file	Everyone

Technical Documentation

Document	Description	Audience	Priority
Architecture Overview	System architecture	Dev, AI, Integrator	⭐⭐⭐
RobotApp Docs	Robot application	Dev, AI, Integrator	⭐⭐⭐
FleetManager Docs	Fleet management	Dev, AI, Integrator	⭐⭐⭐
VDA 5050 Integration	Protocol spec	Dev, AI, Integrator	⭐⭐⭐
Development Guide	Dev setup & workflow	Dev, AI	⭐⭐⭐
Project Structure & Conventions	Project structure, libraries, conventions	Dev, AI	⭐⭐
Appccelerate.StateMachine Guide	State machine library usage	Dev, AI	⭐⭐
Realtime Integration Guide	Linux realtime integration	Dev, AI	⭐⭐
AI Collaboration Guide	AI agent guide	AI	⭐⭐⭐

🔍 By Technology / Theo Công nghệ

.NET 10 / C#

• Development Guide - .NET 10 setup
• Project Structure & Conventions - Project structure, libraries, conventions
• AI Guide - C# patterns

Blazor

• RobotApp Documentation - Blazor UI for robot
• FleetManager Documentation - Blazor UI for fleet

MQTT

• VDA 5050 Integration - MQTT usage
• Architecture Overview - MQTT broker setup

Database

• SQL Server (FleetManager): FleetManager Documentation - Database schema
• SQLite (RobotApp): RobotApp Documentation - Local database
• Development Guide - Database setup

VDA 5050 v2.1.0

• VDA 5050 Integration - Complete guide (v2.1.0)
• AI Guide - Implementation patterns
• New in 2.1.0: Corridors, Map Distribution & Management
• Backward Compatible: Works with v2.0.0 systems

VDMA LIF

• MapEditor Documentation - Map standard
• MapEditor VDMA LIF Standard - Standard details

📖 Reading Paths / Lộ trình Đọc

Path 1: Quick Start (AI Agent)

⏱️ Time: 30-45 minutes

1. AI Guide - 15 min
2. Architecture Overview - Skim (10 min)
3. VDA 5050 Integration - Skim (10 min)
4. Task-specific docs - 10 min

Outcome: Ready to start coding

Path 2: Quick Start (Developer)

⏱️ Time: 1-2 hours

1. Project README - 5 min
2. Development Guide - Follow setup (45 min)
3. Architecture Overview - 20 min
4. VDA 5050 Integration - Skim (15 min)
5. Component docs - 20 min

Outcome: Environment setup, ready to code

Path 3: Deep Dive (Complete Understanding)

⏱️ Time: 4-6 hours

1. Project README - 10 min
2. Architecture Overview - 60 min
3. VDA 5050 Integration - 90 min
4. RobotApp Documentation - 60 min
5. FleetManager Documentation - 60 min
6. Development Guide - 45 min
7. AI Guide - 30 min (if AI)

Outcome: Complete system understanding

Path 4: Integration Focus

⏱️ Time: 2-3 hours

1. Architecture Overview - 30 min
2. VDA 5050 Integration - 90 min
3. RobotApp Documentation - MQTT section (20 min)
4. FleetManager Documentation - MQTT section (20 min)

Outcome: Ready to integrate with third-party systems

🔄 Documentation Updates / Cập nhật Tài liệu

When to Update Documentation

Update docs when:

• Adding new feature
• Changing architecture
• Modifying VDA 5050 implementation
• Changing development workflow
• Finding errors or gaps

How to Update

1. Identify which document(s) need updates
2. Make changes following documentation style
3. Update "Last Updated" date
4. Update this map if adding/removing documents
5. Commit with clear message: docs: update [document name] - [reason]

📞 Help / Trợ giúp

Can't find what you need?

1. Search across all docs using IDE/editor search
2. Check docs/README.md for overview
3. Ask project maintainers
4. Check git commit history for recent changes

Documentation issues?

• Found error? Create issue or fix directly
• Missing information? Request addition
• Unclear explanation? Request clarification

🎯 Quick Reference / Tham khảo Nhanh

I want to...

• ✅ Understand the project → Project README
• ✅ Setup environment → Development Guide
• ✅ Understand VDA 5050 → VDA 5050 Integration
• ✅ Work on robot → RobotApp Docs
• ✅ Work on fleet manager → FleetManager Docs
• ✅ See system design → Architecture Overview
• ✅ AI agent onboarding → AI Guide
• ✅ Debug MQTT → VDA 5050 Integration
• ✅ Write tests → Development Guide
• ✅ Deploy → Development Guide

---

Last Updated: 2025-11-13 Purpose: Navigation guide for all documentation Version: 2.0 (Updated with modular documentation structure and correct tech stack)