iFixit Instructions
I submitted a Fast Fix Project to iFixit for a TECM 5185 (Principles of Technical communication) assignment. My submission is a 13-step guide for installing and replacing 20-inch sediment pre-filters for the Aquasana F-300R 300,000 Gallon Whole House Water Filtration System.
Background
My house has a whole house water filtration system. The plumber who installed it advised us to have him return every few months to change the filter. Instead, I learned to do it myself by reading poorly-written instructions online and through trial and error.
These instructions are important because when the pre-filter is not installed correctly and replaced in a timely manner, water pressure can drop, and sediment particles can enter and clog the main filter tank.
To contribute a Fast Fix Project to iFixit, I coordinated with iFixit’s tech writers. I had to submit a proposal and have it approved before submitting my guide.
Project Skills
Technical Skills
Photography
Plain Language
Conceptual skills
Proposal writing
Instruction writing
Process
Writing the proposal
To write the proposal for my iFixit Fast Fix Project, I had to study the proposal submission requirements and ensure I followed each. I proposed a title for the project, listed my proposed procedure steps, and identified the tools and materials needed. I also had to justify the need for my guide and identify existing repair information already available. My proposal clearly identified the problem, how to solve the problem, and the benefits of my solution.
Writing the procedure
To write the procedure steps, or guide steps, I followed iFixit’s requirements. I included a descriptive introduction. I started each step with an action verb. I used plain language so that an audience with average to below-average technical background can understand. I avoided vague language and ensured the procedure had adequate detail in each step. I included only one step per bullet. I wrote complete sentences and used active voice. I ensured my guide steps were free of grammar, punctuation, and spelling errors.
iFixit suggests that readers should be able to complete the steps using only the text, or only the photos, so my written instructions had to be clear without photos. And my photos had to be clear without instructions.
Shooting photos
Next, I took pictures in accordance with iFixit’s requirements. These had to have correct exposure, show a person’s hands performing the actions described without obstructing the view, have the main focus for each image in the center of the frame, be zoomed in, and have a background clear of clutter.
Communicating with iFixit’s tech writers
I communicated with iFixit’s tech writers several times. The first time was when I submitted my proposal. Communication took place via email memos. Once I received approval on my proposal, I compiled my photos for approval. Once those were approved, I submitted my guide. This included included the following:
- A title
- A descriptive introduction
- Estimated difficulty and time required
- A list of required tools
- Step-by-step instructions
- A photo to demonstrate each step
- Visual markup highlighting key areas of the photos, matched to color-coded bullets in the text
My guide can be found here:
Outcome
My iFixit Fast Fix Guide has had 179 views to date. It benefits readers in the following ways:
- Easy-to-understand instructions and photos that are simple to follow.
- Significant monetary savings since readers can complete the pre-filter replacement without hiring a professional.
- Preventing costly main filter repairs.