Tag Archives: process documentation

Summary of today, and assignments for Monday, December 2

Today we discussed process documentation and shared examples we found online and elsewhere. You may find it helpful to review the Robinson and Edge readings; they provide good examples of process documentation.

This Wednesday, November 27 is a Friday schedule, so we don’t meet. On Monday, December 2 we will review the guidelines for the online documentation project and form groups based on shared interests. Start thinking about the type of project you would like to create: a research tool, an information resource, or a research game. Think about your own information needs and how they are fulfilled (or not) with the strategies and tools we have discussed and used in this class. Attendance next Monday is very important!
Between December 4 – December 11 we will meet in A540, the large e-classroom in the library so that groups can work together.

Remember that the final version of your research paper is due Thursday, December 5 by 10 a.m. If you have questions, don’t wait until Wednesday night!
Enjoy the holiday and the long weekend!
~Prof. Leonard


Step by Step

The only thing that i can relate to a process documentation would be a manual for an aircraft. It gives a small description on how the system/parts work. There are time when more than one manual is used for a single repair. The manual will take you step by step on how to do the job with caution notes inserted between steps. Every little repair or replacement of a part must go according to the manual and FAA standards. Depending on the task at hand missing one step or ignoring a step could be difference between life or death.



The Cider Process 11/25

An example of process documentation that I located was a spiced apple cider recipe. The recipe tells you what materials and how much of each you need to make the cider. An important thing it also mentions is how many servings you will get from the recipe. There isn’t much to the recipe though, all you have to do is combine all the ingredients in a pot and boil. It would be hard to have any problems with this recipe but I am sure it is still possible. As with all recipes, it is impossible to know how it tastes and if you will like it until you are finished preparing it, but that however has less to do with the process and more to do with the ingredients.

Summary of today, and reading/blogging for Monday, November 25

Today we wrapped up our discussion of documentation styles and began our discussion of process documentation. For Monday, please write one blog post on process documentation in response to the following:

Locate one example of process documentation in any format, read it, and write one 100-word blog post in which you describe, summarize and critique it. Does it document thoroughly and completely the process that it claims to document? If you choose a video, please embed the video into your blog post so that we can all view it easily.

You may find it helpful to review the Edge and Robinson articles to guide your selection of a good quality example of process documentation.

The draft of the research paper is due by 10 a.m. on Thursday, November 21, emailed to me as an attachment, please. As always, please get in touch with any questions you have about the assignment.

~Prof. L