Recovering Files with Knoppix

Project Overview

According to the assignment description sheet, the purpose of this project was to show our understanding of the use of DITA and XML for documentation.

We chose to document the steps needed to use a product called Knoppix to recover files on a computer. We documented all of the steps from acquiring Knoppix to completing the file recovery. Once the procedures were completed we demonstrated ways that DITA and XML could be used to create the documentation.

Logistics

1. Group planning and status update meetings were held via Skype typically lasting an hour.
2. Frequent communications were maintained using group emails between Skype meetings.
3. All documents created were stored using Dropbox in order for all members to have access to the most recent version of all documents.
4. A Gmail account was created to serve as the email address for the WordPress site and the YouTube channel for the video embedded on the WordPress site.
5. A free trial of Adobe FrameMaker XML Author 12 was used to generate a ditamap and a concept task from an excerpt of the procedure documented for the project.
6. Deliverables during the project included:
   • written procedure that describes a process for a social media tool or a system
   • media file(s)
   • image file(s)
   • hyperlink(s)
   • usability test report
   • application of DITA and XML techniques to the procedure
7. The final deliverable, this WordPress site, includes all other project deliverables.

WordPress Website Organization

We chose to break up our site into several pages linked by a navigation bar. This allows the user to go directly to the portion of the procedure that interests them most.

Also included are links directly to the Knoppix site as well as other sites of interest such as the other ENG 577 groups’ Project 2 websites.

Usability Test Results

We conducted usability testing in two different stages. One team member performed usability testing on the procedure itself before it was translated into the WordPress blog. That team member later performed another layer of usability testing on the website itself.

 

Usability Test #1 – Procedure for Recovering Files with Knoppix

Category	Evaluation
Progress	I completed the procedure.
Steps	The steps in the procedure were correct.
Graphics and Screens	The graphics and screens were large enough to see and easy to understand.
Explanations	The explanations were clear and they provided additional detail, as needed.
Terms	The terms were appropriate for the subject matter and the intended audience.

 

Usability Test #2 – WordPress Website for Documenting a Procedure

Category	Evaluation
Navigation	The website was easy to find and it was easy to navigate between pages.
Links	The links to internal and external references worked as intended.
Graphics and Images	The graphics and images loaded quickly and completely on each page.
Explanations	The explanations were clear and they provided additional detail, as needed.
Text	The text was easy to read because the size was large enough and it was easy to differentiate between the styles (paragraph, heading, etc.).