Home > Adaptability > Repair Manual

The Challenge

The purpose of this project was to create a repair manual for a Dell Optiplex 7010 PC unit. This was a group project for a class in which each group was given an old PC unit to examine and document. Each group was also given sample materials and manuals for their PC units. We created the final manual in MadCap Flare and we created both PDF and HTML formats.

Sitemap

To plan the structure and contents of the final manual, we created a sitemap. The sitemap was divided into five larger sections/chapters which then branch off into several smaller sections. In addition to the full sitemap, we created smaller maps for each individual chapter that we included in our strategy report for the project.

Wireframe

After creating the sitemap, we created a functional wireframe for the HTML version of our manual. This gave us an idea of how to design the HTML in MadCap Flare and gave us an idea of how our content should be organized on each HTML subpage.

Documentation

We then wrote our content in Flare, organized the content, formated the documents, and created our final manuals. You can see the full PDF version of the manual at the link below.

Skills

This project displays my ability to learn new tech/programs to create a product. Prior to this project, I had never used MadCap Flare before. I learned how to use MadCap Flare as well as MadCap Central - an online authoring and collaboration tool. I learned how to use these two programs in tandem in order to create the manual with my team in a virtual environment. We were able to collaborate and communicate effectively throughout the project, an aspect in which MadCap Central helped greatly. Additionally, I learned the online wireframe builder MockPlus, which I had never used before this project.