NEED HELP!!! :ahh:
We are a rookie team and we would like some suggestions on how to get started on the documentation. We have done documentation work for the BEST robotics and were wondering if it was similar.
The first thing that you need to do is decide which type or types of documentation that you intend to do. Video documentation is different than written documentation.
If you decide to go for video documentation, the first step is to make a storyboard. This is an outline for the things that you will want to put into the video. It basically gives you a list of the things that you will want to take footage of so that you don’t have to take a bunch of random footage that you’ll never use.
If you decide to go for written documentation, the first thing that you’re going to want to do is to decide what you want to put in. (This is the option that you would use if you want to do a documentation for a Chairman’s submission) My best advice for this one is once you decide what information you want to put into the documentation, assign 1-2 paragraphs for each topic, depending on how important it is.
My best advice for documentation, be open to new ideas. If people have different ways of doing things, or think that something should be added that you hadn’t thought of, make sure to add their ideas. Your documentation is always better when there’s teamwork involved.