Tag Archives: documentation

A few real-life examples of documentation

Erin’s post reminded me that I wanted to post about the three real-life examples of documentation that I showed you in class yesterday:

1. A short handout that’s available at the Reference Desk in the library that explains how to use the catalog to find textbooks on reserve in the library. We don’t have an online version of this handout so I can’t link to it here (but perhaps we should create a PDF and upload it to the library website).

2. A video tutorial that the librarians at City Tech created to demonstrate how to find journals by title using the tools on the library website. Often documentation like a manual, instructions, and guidelines is in text form (either in print or online), but sometimes documentation can be effectively presented using video and/or audio. This video is on the library website — you can watch it here.

3. The guidelines that my colleagues and I created to explain how to use Google Calendar to organize the library schedule, from Reference Desk shifts to library classes to meetings. I can’t link to this one either because it’s on our intranet: a private internal website just for library faculty and staff. Many organizations use intranets to store and maintain documentation of processes and practices of the organization, and you might need to use an intranet in your careers.

See you tomorrow,
Prof Smale

Selecon Pacific MSR

Backwards blog post: Here’s a link to the operation manual for the Selecon MSR light fixture that I showed in class. We were supposed to find our source, blog about it and then discuss it in class. I’m behind in my blogging (we all are) and this is my attempt to get back on track (let’s all do it!).

The operation manual is a technical guide to setting up, operating, repairing, accessorizing and maintaining this fixture. It is not a quick-start guide like the one Professor Smale demonstrated but more of a guide for people who sort of already know what they’re doing. Due to the intricacy of knowledge required for proper operation, this guide is appropriate. As I stated in class, I have done a sort of quick-start guide for units like this aimed at people with less technical knowledge but tailored to particular uses of the fixture they required.
We’ve spent a great deal of time researching this semester and now it’s time to focus on the latter half of the title of our course. The topic is process documentation. The purpose is to make us all more familiar with the term and what it means to document a process. Then, as per our group project, document the processes from a theme in our research paper in conjunction with a related theme in our partners paper. Now… I just need to write my paper… 🙂