Category Archives: web

iFixit: how repair manuals should look like

What can technical communicators learn from iFixit.com? This site offers step-by-step instructions for users to repair their own devices easily and cost-effectively. While iFixit proudly says their website “is the free repair manual that you can edit,” it also is the “hidden” manual that anyone can use and contribute to.

iFixit Guide

iFixit has several thousand guides and user-contributed solutions for a variety of devices, appliances, and vehicles on the website.

I first used iFixit when my MacBook had a hard drive attack in 2010. I was worried how complicated and costly it may be to replace my drive in my beloved Apple laptop. As a college student, the economics are simple: buy a $50 hard drive from NewEgg.com or pay about $150 in repair costs from the Apple store.

If someone has the patience and organization to take apart their devices, this website makes repairs extremely affordable and easy. The benefits may outweigh the risks if users are comfortable with the slight risk of damaging their own property.

iFixit - color-coded-system

This example shows the color-coded system which the dots and circles correspond to the correct screwdriver size.

What can we learn from this website that we, as technical communicators, can apply elsewhere in help documents? iFixit’s manuals are extremely useful because of these simple principles:

  • Step-by-step instructions
  • High quality large photos
  • Consistent directions and warnings

Their manuals are helpful because of the quality of the content available. For example, each step has specific directions, color-coded labels, and sometimes a warning symbol for disassembling devices.

One issue I have with computer manuals is the diagrams and pictures hardly show the positioning of tools or hands to demonstrate how something can be taken apart.  This human and practical element is great to have because users can relate to and follow instructions easily without imagining where hands or tools are placed. It also does not benefit the user to display arrow pointing to where the tool needs to go either. A computer-generated arrow never should replace screwdrivers, spudger tools, or hands. Let me repeat, arrows are great but not the same.

iFixit - hand, spudger, and warning

This example shows simple instructions, a clear picture, and a warning symbol for repairing a MacBook.

The second aspect I truly believe is important is user feedback and contributions. iFixit’s manuals are editable in a wiki so if anyone reads a repair manual and finds an improvement, they can add it to the manual.

In conclusion, we can see how iFixit’s examples can be a model for how we can write online repair and assembly manuals. Their approach is rather innovative and simple and we can learn how to improve our documentation with real-world scenarios and user feedback.

I recommend that you use this site, contribute your technical communication expertise, and buy replacement parts from them. By supporting iFixit.com, not only do you save money, you learn something new and keep fewer devices from becoming trash and causing further environmental issues. For more information, read their mission and manifesto.

Website Meltdown: Lessons Learned

Site Meltdown

Websites can meltdown...

As a technical communicator, I’m reflecting on my learning experience as much as possible. This is a potential venue that any technical communicator can capitalize upon because we sit in the middle between the creator and the consumer. We write about and use the product at the same time. Below is my crash-course lesson on moving a WordPress site to a new hosting company. It was not as daunting of a task as I thought it would be.

Over the last three days, my blog site experienced a meltdown with my previous hosting provider. This event forced me to move to a better hosting company. So far I am extremely satisfied with the move, except it was more complicated than I bargained for and a HUGE lesson learning how to migrate WordPress to a new host. Was it worth the move? Yes, I  save $40 per year in annual hosting costs and have a faster-loading site.

Beware that moving a website like a WordPress blog is not an easy task if you don’t know the details regarding HTML, FTP, PHP, Apache Configuration, mySQL, Zone Files, A Records, and DNS. Thankfully the internet has instructions on fixing these issues that may arise as a result of trial and error.

Download and  backup everything

First, I downloaded my entire site to my computer–images, directories, and files. Everything in the WordPress directory had to be downloaded. I also downloaded a backup copy of the mySQL database which WordPress operates from. These two items are what make up WordPress.

Upload

Next, I uploaded the WordPress directory to my new hosting company. Also, I had to create a new database on my new host and import the data from the existing database I downloaded. These tasks were relatively simple and rather trouble-free.

Edit certain files

Then came the tricky and ridiculous tasks. When I uploaded my database, I had to update certain files and redirect where my new database was. This change somewhat caused confusion and initially broke the site. At least there was a way to figure out how to resolve these issues. WordPress.org helps users with their guide to Moving WordPress to a New Server.

Domain Name Resolution

404 Not Found

DNS changes caused the site to go down.

It usually takes 24+ hours for domain updates to completely be resolved. Normally hosting companies manage domains, but I keep domain management separately with different company so I have more control over how my domains work. When I updated my domain name to point to my new hosting server, it did not completely work. There was an error when I changed the IP address of the server and both www.writetechie.com and writetechie.com. Each of those addresses are different and should point to the same IP address, but they did not. Both sites were going to the wrong place and causing havoc on the site.

Lessons Learned

I’ve learned a bit from moving sites and now I’m ready to move WordPress installations in the future without worry.

  1. WordPress and hosting sites are fickle creatures
  2. Hosting companies are rather helpful with their knowledge bases
  3. Documentation found on the internet resolved configuration issues
  4. Patience is extremely important–someone probably has gone through this before
  5. Sheer joy once everything works the way it was–and faster too!
Website Meltdown

Avoid Website Meltdowns.

If you have any tips please share them in the comments. If you need some help moving your WordPress blog, I am willing to lend a hand. My next site move should go much smoother from now on rather than the meltdown.

Note: I took these photos of reactors on my trips out to Pennsylvania and Illinois, respectively. My passenger plane safely flew over both of these structures. I just happen to have a point and snap digital camera with a decent zoom lens.

New Article: Leveraging Talents, Skills, and Passion on TechWhirl

I have added another article about LavaCon 2011, this time a feature with Corey Ganser from MindTouch. Please check out, “Building the Business Case for Technical Communicators by Leveraging Talent, Skills and Passion

This interview was co-authored with Connie Giordano, co-owner of TechWhirl. Corey shared his insight on how technical communicators should place themselves within a company and serve in many different roles, such as technical support, marketing, as well as documentation.

Take some time out of your busy day and read “Building the Business Case for Technical Communicators by Leveraging Talent, Skills and Passion,” along with other coverage I have done for TechWhirl.