How to document

Screen Shot 2013-08-26 at 10.46.03 AM


Documentation is a very important part of this course, for a few reasons:

1) This is still an emerging field and, as you will find, there is still a dearth of resources that demonstrate how to contruct or troubleshoot different projects and processes.

2) This is very much an open source community. We all learn from each other’s work, failures and successes alike. Remember: Sharing is caring.

3) As a designer, this is just a good habit to get into, especially since everyone will have to do it for thesis.

4) This is my least favorite reason and incentive to give: If you do not document assignments properly, it will reflect heavily in your final grade.

Documentation can be quick and it will get easier the more you do it. Paragraphs are not required – you may list items. You should spend no more than 20 minutes on it. Documentation for assignments will be checked for grading at midterm and final (in the off chance you miss one :). Documentation for bigger projects (midterm, group presentation, and final) are due the day of presentations.


Please follow the template below for each post:

0) Log into the blog (http://lizastark.com/compcraftfall13/wp-admin) and create a new post.

1) Give your post a title using the following format: Title (Week __)

2) Under “Category,” select your name. ***If you do not do this I will not see it when I grade it***
Screen Shot 2013-08-26 at 10.45.48 AM

3) Include an image/video of your final product at the top of the post.

4) Describe your project briefly. What does it do/How does it work? Is it for a particular audience?

5) List the materials used. If they are not in our class resource list, include a link.

6) Record any images and/or video that document your process.

7) Drawn diagrams of your circuit and data tables (when appropriate). For instance, when we will be measuring resistance of different lengths of thread or time for thermochromic ink to change color.

8) Discuss any challenges, frustrations, and successes you encountered.

9) Insert the Read More quicktag, otherwise your post will go one forever.
Screen Shot 2014-08-26 at 5.31.16 PM

10) Publish it!

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>