[ECE 453] Final Documentation stuff
- From: "Logen Watkins" <slapkey@xxxxxxxxx>
- To: 453_all@xxxxxxxxxxxxx
- Date: Sat, 22 Nov 2008 04:33:26 -0500
Howdy,
Tentative flow of the document...
System Specs -- Most broad overview of our project, covering each of the 3
groups. *This section needs to be updated.* For instance, it currently
mentions that everything is being powered with solar panels and marine
batteries, which isn't true.
Time lines -- If you have any modifications to the time lines, I'll need
those dates from you -- I'm sure several have changed
System Architecture -- Make sure this section has been updated with the
changes that your particular group has made throughout the process.
*Also** -- I think it would be beneficial if a small area (paragraph
or two) was added to this section at the very beginning describing again the
general flow of information from one system to the next. Really just
expounding a little bit on the ideas from the System Spec*
Component API -- I'm sure that the current version of the Team Documentation
is outdated, so each group will need to update their sections for
submission.
-- Need an updated picture of the TMC interface, btw.
*New Stuff*:
Component Testing -- *Small introduction describing process of having each
component testing separately before integration (benefits of thorough
testing before merging? heck idk) *As mentioned several times in our class
sessions, we need to show *why* the system was implemented the way that it
was, or why we made the decisions that we did. This would be the place to
show why X was such a horrible idea, and why Y or Z worked much better.
Whereever possible, supplement this section with screen captures and/or
statistical analysis. Wang really wants this section to say "our project's
design makes sense -- here's why."
*Installation* -- Again broken up by group, any software and hardware
installation that has taken place needs to be documented here.
Camera group, talk about setting up the embedded PCs, getting Birchfield's
software running on them, that whole thing.
Network group, the routers and gateway setup, why you chose the firmware you
did, what it's like to establish new nodes, accessing the network..
TMC, talk about server setup, database functionality, and
anything/everything related to the user interface that we've set up.
*Discussion topics *-- These I believe have all been submitted to me. I'll
do some minor proofreading and potentially make some changes to make them
sound similarly written, but I'm going to assume you gave me good stuff (or
at least as good as possible, given the topics).
*Code Appendix* -- Looking at last year's documentation, they included a
great deal of actual code, in addition to the stub code in the component
section. We can do this as well -- just please have it broken up for your
group as you would like it, labeled and marked clearly.
In conclusion -- there's quite a lot that still needs to go into this
document, and it's due Tuesday night. For the "new" section, each group
needs to submit their stuff to me indepently for integration to the
documentation. As mentioned above, I think the following areas could use
some TLC. These 3 things shouldn't be major time commitments, just some
quick writing. I'm just going to "assign" these at random.
System Specs -- Network Group
System Architecture "introduction" -- Camera Group
Component Testing "reasoning" -- TMC Group
Any questions...direct them at Ben! OK just kidding, let me know. Along
with updates to our previous work, the most important areas to get put into
this document are the first 2 of the "new section." Please try and have
everything you possibly can to me by Monday night, as I'm going to be
working on this Sun/Mon/Tues, but am also working all 3 of those days, which
is going to make the process difficult. I'm not exactly sure what the
revision process is after revision, but considering next week is
Thanksgiving and the following week we are supposed to have a
fully-functioning project, I don't much expect we'll make very many.
The old team documentation is attached, for those wanting a copy
Your Fearless Class Lead (A.K.A. why me?)
Logen
Other related posts:
