Skip to content

Welcome to RoBorregos Documentation

This is the documentation for RoBorregos. Here you can find information about the team, the projects we have worked on, and the tools we use.

RoBorregos

RoBorregos is the Tecnológico de Monterrey's International Robotics Representative Team. We are a team of students passionate about robotics and technology that have several projects in which we participate. To learn more about us, visit our website.

Sections

Principles for Effective Documentation

What to Document

1. Engineering & Development

  • System Architecture: The general logic and development cycle of the specific area (Programming, Mechanics, or Electronics).
  • Design Rationale: Clear justifications for the design decisions made.
  • The "Graveyard": Algorithms that were tried but didn't work out, and components that were bought but didn’t integrate well.
  • Assets & Visuals: Images of schematics, CAD models, final robots, and code architecture diagrams.
  • File Access: Direct links or pathways providing access to the actual, usable source files.

2. Hardware Failures & Troubleshooting

  • Incident Reports: Detailed accounts of errors, everything that went wrong, and the specific solutions used to resolve or avoid them in the future.
  • Hardware Casualties: A log of components that were burned out and specific mechanical failures.

3. Competition Experience & Strategy

  • The Reality on the Ground: Honest accounts of the experience during the competitions.
  • Tactics: Which ad hoc strategies worked when under pressure?
  • Surprises: What unexpected events or challenges happened?
  • Future Prep: Concrete advice on how the next team can better prepare for these specific events.

4. Knowledge Transfer & Onboarding

  • The "Wish I Knew" List: Things you wish someone had told you when you first started.
  • Wisdom: Core lessons learned that you want to pass on to the next generation of the team.
  • External Resources: Links to tutorials, forums, or datasheets that proved highly useful.

5. Project Management

  • Approach to manage the project (gant, scrum, etc.), meeting frequency, duration, & meeting structure.
  • General timeline of the project: start of project, when where the components bought (i.e. custom pcbs), date and description of each prototype iteration, date of final robot
  • Things that could have been improved in hindsight (management-wise)
  • What were the goals set at the start of the project? Were they modified after the start? Were the objectives achieved?

Best Practices

  • Assume Zero Context: Always remember that this documentation will be read by a new member with no prior knowledge of the project.
  • Clarity Above All Else: Use clear and simple language. Avoid unnecessary technical jargon, or explicitly define it when it is unavoidable.
  • Keep it Concise: Provide value with each sentence. Respect your teammates' time by getting straight to the point.
  • Show, Don't Just Tell: Include images, wiring diagrams, and flowcharts wherever possible to break up text.
  • Structure Your Work: Organize sections with clear headings.
  • Create an Index: (Optional but highly useful) Include a table of contents or index for easy navigation.

Tools

Development team

Name Email Github Role
Iván Romero i.wells.ar@gmail.com @IvanRomero03 Repo Mantainer and Documentation Lead