Difference between revisions of "3lb Documentation Guide"

Revision as of 14:20, 21 September 2018

(Bot Name)
(Highlight text)
Year Of Creation	20XX-20XX
Versions
Current Version	X.X
Update Year	20XX-20XX
Wins/Losses	X/X
Information and Statistics
Weight Class	BeetleWeight
Weapon Class	(weapon type)
Combined Wins/Losses	X/X
Weapon Speed	(RPM)

(Replace this text with an overall introduction of your robot's design, name, features, ect)

Design Log

Week 1: Sep 24 - 28

What we got done since last meeting

Here's where you could put a small update, like that you finished a part in CAD.
Or you could write about how you came in between meetings to the shop to machine a part.
You could also list the results of any non-official meetings your team held.

What we want to get done this meeting

Here's where you would list the goals your team has for what you want to accomplish this meeting.
For example: Finish the Top Plate and Weapon Assembly in CAD
Or: Machine the pockets for the side walls

What got done and what changed this meeting

Here's where you would say what actually got done this previous meeting
For example: We only finished the Top Plate in CAD
Or: The mill was in use during the entire meeting, so we decided to water jet our armor instead

What we want to get done before the next

Heres's where you would say what you want to accomplish between now and the next official meeting.
For example: Finish the Top Plate CAD and add the Weapon Assembly to the assembly.
Or: Come in over the weekend and mill the sidewalls

Week 2: Oct 1 - 5

Week 3: Oct 8 - 12

Week 4: Oct 15 - 19

Week 5: Oct 22 - 26

Week 6: Oct 29 - Nov 2

Week 7: Nov 5 - 9

Week 8: Nov 12 - 16

Week 9: Nov 19 - 23

Week 10: Nov 26 - 30

Week 11: Dec 3 - 7

Week 12: Jan 7 - 11

Week 13: Jan 14 - 18

Week 14: Jan 21 - 25

Week 15: Jan 28 - Feb 1

Week 16: Feb 4 - 8

Week 17: Feb 11 - 15

Competitions

Motorama 20XX

Results:
- Bracket Style:
  - [(Video Link) (result) vs (opponent)]
    - (notes)
    - (observations))

Version

(Bot Name) VX.X

Created by: (Names of Builders/Group Members of aforementioned version of bot)

Drive Motors	(Drive Motor Name)
Drive Motor Controllers	(Drive Motor Controller Name)
Weapon Motor	(Weapon Motor Name)
Weapon Motor Controllers	(Weapon Motor Controller Name)
Receiver	Hobby King 2.4Ghz Receiver 6Ch V2
Remote Control	Hobby King 2.4Ghz 6Ch Tx and Rx V2
Battery	(Battery Name)
(OTHER:)

Problems

(List of Problems, 1 per bullet point)

Good aspects

(List of good aspects, 1 per bullet point)

Changes/Improvements

(List of suggested improvements/changes, 1 per bullet point)

Notes:

(random joke, optional)

(Naming inspiration, optional)

(Names of original builders)

@@ Line 40: / Line 40: @@
 === Week 1: Sep 24 - 28 ===
-==== What we got done since last meeting ====
+'''What we got done since last meeting'''
 * Here's where you could put a small update, like that you finished a part in CAD.
@@ Line 46: / Line 46: @@
 * You could also list the results of any non-official meetings your team held.
-==== What we want to get done this meeting ====
+'''What we want to get done this meeting'''
 * Here's where you would list the goals your team has for what you want to accomplish this meeting.
@@ Line 52: / Line 52: @@
 * Or: Machine the pockets for the side walls
-==== What got done and what changed this meeting ====
+'''What got done and what changed this meeting'''
 * Here's where you would say what actually got done this previous meeting
 * For example: We only finished the Top Plate in CAD
 * Or: The mill was in use during the entire meeting, so we decided to water jet our armor instead
-==== What we want to get done before the next ====
+'''What we want to get done before the next'''
 * Heres's where you would say what you want to accomplish between now and the next official meeting.
 * For example: Finish the Top Plate CAD and add the Weapon Assembly to the assembly.