Educado Documentation Hub
Welcome to the Educado documentation! Here, you will find all the essential information about the project, from an overview to technical and configuration details.
🔗 Quick Links
📚 Table of Contents
🛠️ Project Management
| Document | Description |
|---|---|
| Roadmap | Timeline and project phases |
| Workflow | Processes and development flow |
| Meetings | Meeting notes and summaries |
| Deliverables | Expected outcomes and deadlines |
| Issue Tracking | Bug tracking and issue management |
| Lessons Learned | Post-mortems and continuous improvement notes |
📦 Product Documentation
| Document | Description |
|---|---|
| Product Overview | High-level description of the product |
| MVP Features | Core features for the Minimum Viable Product |
| Product Backlog | Backlog building process |
| Project Vision | Strategic vision for the project |
| Project Objectives | Goals and objectives |
| Stakeholders | Key project stakeholders |
💻 Technical Documentation
| Document | Description |
|---|---|
| Accessibility Evaluation Report | Accessibility evaluation report |
| API Specification | API definitions and guidelines |
| System Architecture | High-level system design |
| Database Schema | Database models and relationships |
| Development Lifecycle | Stages of the development process |
| Tools & Dependencies | List of required tools and libraries |
⚙️ Setup & Configuration
| Document | Description |
|---|---|
| MkDocs Configuration | MkDocs project settings |
| MkDocs Setup | Instructions to set up MkDocs locally |
| Python Virtual Environment | Setting up a Python virtual environment |
| Publishing Guide | How to publish project documentation |
| README | Project overview and installation |
🔗 References
| Document | Description |
|---|---|
| References | External resources |
Revision History
| Date | Version | Changes | Authors |
|---|---|---|---|
| 2025-03-28 | 0.1 | Document creation | Cainã Freitas, Lucas Antunes |
| 2025-04-15 | 0.2 | Product Overview update content | Lucas Antunes |
| 2025-04-18 | 0.3 | Update home page | Mateus Vieira, Lucas Antunes |
| 2025-05-13 | 1.0 | Completed all sections and added US , Added Content QA information and minor adjustments, Project Overview update content, Objectives update content | Vitor Trancoso, Victor Andreozzi, Leandro Almeida, Pedro Rodrigues |
| 2025-05-14 | 1.1 | Add wiki ref | Mateus Vieira, Lucas Antunes |
| 2025-05-29 | 1.2 | Refactor Backlog and create US | Lucas Antunes |
| 2025-06-02 | 1.3 | Add new PDF classification tool | Lucas Antunes |
| 2025-06-09 | 1.4 | [Update] - Product Overview, MVP definition, Database Schema, Wiki, Project/Overview, Project/Objectives, Deliverables, Tools, Api Schema | Lucas Antunes |