Tag Archives: process_documentation

Notes from today, and reading/discussion for Monday, 11/28

Today we spent some time discussing the nature of process documentation, and we looked at a few blog posts that demonstrate process documentation. If you want to post your example, I’ll give you until the end of today to do so with full credit. On Monday we’ll discuss more practical applications for documentation,  and we’ll establish groups for the online documentation project. For Monday, please re-read the Edge and Robinson articles about documentation (assigned for today).

If you have questions about the research paper final, please get in touch by email. If you handed me a late draft, I’ll get it back to you with comments as soon as I can; if not later on today, then I’ll aim for Friday or Saturday. Your final papers are due on Wednesday, November 30 by 10 a.m.

Slides from today are available here.

Enjoy the long weekend!
~Prof. L.

Your blog post on process documentation

For Monday, your (final!) blogging assignment is to find one example of process documentation and share it with the class. Your example of process documentation can take any form: a video, a web page, or even a printed manual or document. It should document how something is done thoroughly enough so that any viewer or reader fully understands how to do the process successfully and arrive at the same results that are demonstrated. Documentation of a process helps standardize the process of doing, making, or building something. Process documentation is often performed in the field of software development. Software writers document how they accomplish specific tasks, and in what order, so that other teams can replicate the process without “reinventing the wheel” each time. Good process documentation also starts by stating the goal or purpose of the process and lists all equipment and skills that are necessary to the completion of all tasks.

Here is an example of a video that documents the process of medicating a pet cat:

This blog post from the University of Virginia Scholars Lab documents the process of geocoding places on a map using ArcGIS software; that is, how to match a list of street addresses to points on a digital map that can then be edited or shared in a variety of ways.

Notes from today, and reading/blogging for Wednesday, November 23

On Wednesday, we’ll discuss the practical applications of documentation and come up with a definition of process documentation. Your assignment is to find one example of process documentation in any format, read it, and write one blog post in which you describe, summarize and critique it. Be prepared to discuss your example in class! If you use a video or other media as an example, embed it into the course blog. Please read the following 2 articles that discuss issues in process documentation:

Edge, “Write it down! The importance of documentation
Robinson, “Documentation Dilemmas

By the end of class on Wednesday I would like to establish groups for the documentation project. Each group will consist of three students and will propose an information resource, an educational game, or a media outlet and document the process of research. I will post guidelines for this project later this week.

Continue to work on your research paper; you should get a graded draft back by the end of the day Wednesday. The final version of your research paper is due Wednesday, November 30. A few people still have not turned in the outline or annotated bibliography; remember that you must submit all parts of the research paper to get credit for the project.

~Prof. Leonard