I know a lot of teams have awards booklets and such for the business side of the team that both track team reach and highlight achievements and haven’t seen too many books like that on the technical side. Are there any technical documentation methods that your team uses that seem to work really well? Please include links if you can! Thank you!
You’re sure to get lots of great replies, I’d say overall one important thing to consider for any writing but especially technical documentation is the audience (and their technical knowledge level).
Are you writing to other designers/coders in FRC? Judges who may be engineers? Or someone’s grandpa who is just supporting their kid? Understand what your audience is and then tailor your documentation accordingly.
254 primarily creates Technical Binders. These consist of an intro that describes strategy and subsystem pages that overview the functions, these try to be broadly approachable. The details in the bullets are answering specific questions about mechanics, ratios, and trade offs that other FRC people might care about. That’s how we strive to tailor it to a broad audience.
We print these binders out and let people skim through at event, we will typically give one to a judging pair to take back to the judging room.
Recently we’ve also been treating Tyler Old’s FUN videos as a form of technical documentation, it’s like what we would demonstrate if someone came and ask for a robot demo in our Pit.
10 Likes
This topic was automatically closed 365 days after the last reply. New replies are no longer allowed.