Tag Archives: documentation

Class notes 11/18/10

Today we discussed documentation of processes or products, and you demonstrated the documentation sources you found for your homework.

We also discussed your research paper draft, and some issues that appeared frequently in your drafts.

More details are available in today’s slides.

Also, here’s the formatting example for your final research paper that I handed out in class today.

There’s no reading or homework this weekend other than revising your paper. Your final paper is due on November 30th! Detailed guidelines are available on the Assignments page.

Please let me know if you have any questions.
Have a good weekend,
Prof Smale

Advertisements

Documents

I choose a manual of an electronic Drum Pad from the 80’s, in this manual they have the information of the artifact, they explain how it works, and how you can improve the sounds that you can create with that instrument. In this manual you have diagrams, technical descriptions, contact information, etc. I think that this documentation is really excellent organized. This manual also comes in different languages which makes more comprehensible for more people from different countries. I think that when some information has to be documented, it needs to be clear, well organized and must be explained in a manner easy to understand.

 

Class notes 11/16/10

Today we spent part of the class peer reviewing the research paper drafts, and part working on citations.

A few citation guidelines:

1. When in doubt, CITE!

2. Most important parts of a citation:
Author
Title
Date

If it’s an article:
– Journal/magazine/newspaper title
– Volume
– Pages

(Badke, p. 156)

3. Remember, you are citing your sources to document your research process. Anyone interested in reading your original sources must be able to find them, so be sure to include enough information so someone can find your original sources from your citations.

Homework for 11/18/10

Hi everyone,

Here is your homework for Thursday:

– Find one example of process documentation in any format

– Read/view it!

– Write one blog post (100 words minumum) in which you describe, summarize and critique it

– Be prepared to demonstrate and discuss your example in class

What is process documentation? Anything that documents (records) the process of doing something. The documentation you find can be text, video or image-based — any media is fine, as long as it’s an example of documentation of a process. Examples I gave in class include an instruction manual, your research journal blog posts, etc.

Please let me know if you have any questions.

Best,
Prof Smale

Class notes 11/11/10

Today we started discussing documentation, which we’ll be focusing on for the next 3 classes.

We began with a definition from the Oxford English Dictionary (search for documentation, also the verb to document). The OED is a historical dictionary and as such it documents the history of the words it includes, as well as defining them.

Next we moved onto the Hauptman reading, which poses the question Why Do We Document?

– Acknowledgment
– Attribution
– Tracing
– Validation
– Protection against accusations of misconduct
– Tangential substantive commentary

(Hauptman, 2008, 7)

We discussed and looked at examples of each.

Ultimately, documentation and citation:

– Acknowledge participation in the scholarly conversation
– Illuminate and preserve process/practice/research path

And are important to:
– academic work
– all kinds of professional work

We also discussed the article in the Chronicle of Higher Education about link rot: a term that describes the increasing numbers of dead links in citations from scholarly books, articles and other information sources that refer to the internet. A great example of this is the Badke chapter that discusses specialized search engines: you’ll remember that when we discussed those sites in class we discovered that many had already disappeared.

The Chronicle article mentions the Internet Archive, which is one resource you can use to try and find old internet resources. We also discussed the Wayback Machine as a way to view old versions of websites. I tried to show you the City Tech Library’s old website, but kept running into an error. If you’d like to try it yourself, visit the Internet Archive at http://www.archive.org/ and enter in the library’s URL: http://library.citytech.cuny.edu.

Homework for 11/11/10

Hi everyone, just want to remind you about the homework for Thursday. Please be on time for class on Thursday, because we will begin with a short quiz on the reading:

– Read the Hauptman excerpt that I handed out in class today. If you missed class today and want to pick up a copy of the reading, please email me to arrange a time. The Hauptman book is also on reserve in the library, call number PN171 .F56 H38 2008 (read pages 7-13).

– Read this short article in the Chronicle of Higher Education: A Modern Scholar’s Ailments: Link Rot and Footnote Flight.

Also remember to write one comment on any of your classmates’ blog posts.

Please let me know if you have any questions.