Category Archives: technology

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.

Is Generation Y Not Taking Social Media Seriously?

I read an interesting article, “Generation Y’s career Facebook Fumble,” which I feel tells half the story and not the whole story about my generation’s tangled history with social media. Keep in mind that Generation Y created today’s social networking and it flourished from there.

First is first, let me lay down the groundwork for my thoughts on the current state of social media:

  • Facebook is a playful social network
  • LinkedIn is the professional networking site
  • Twitter is the established quick and short messaging site
  • Google+ is emerging as a new player in the field of social media
  • MySpace is in the digital graveyard along with other less prominent social networking sites

Facebook – the playful network

Playground

Facebook is the social playground

Historically, Facebook was an exclusive club designed only for college students. It was when the company began opening its network up to allow major corporations and geographic regions to join, the problems started becoming mainstream. I will admit, college students freely expressed themselves on the site and it was more of a status symbol by networking with the most friends, posting on various groups, and having photos of yourself after those so-called social gatherings. Problems on Facebook constantly plagued students and college administrators. When Facebook opened up to the public, it was a huge social experiment and train wreck at the same time. Suddenly the popularity of Facebook made it possible for everyone to connect with each other and may inadvertently caused some generational clashes–mostly between mom/dad vs. son/daughter. Parents would often want to check up on their kids and sometimes it got ugly.

Notably, the issues began when people discovered inappropriate photos and inappropriate postings on Facebook and it happened to be reported on the news. It still happens todoay, but not as much as it used to. We have learned how to manage our social media much better than the heyday.

Linking professionals with LinkedIn

Now I want to switch gears and talk about LinkedIn. It is a social networking site intended to showcase one’s own career goals, resume, and accomplishments. This place is excellent for showcasing the world our professional lives. In the past year, I have received more LinkedIn connection requests from my colleagues in college than I have before. Since joining the site in 2008, I added over a dozen of my college friends who are seeking professional employment because they care about their professional life and wish to be associated with other successful peers on this social networking site. There are many benefits by using LinkedIn, such as

  • requesting letters of recommendations
  • associating with professional groups
  • listing accomplishments and goals
  • showcasing major projects
  • participating in professional discussions
  • seeking new employment opportunities
LinkedIn is essentially a social network built around a professional resume.

 

Social Media Study

Cited in the article is the Gen Y and Facebook Study, conducted by Millennial Branding, which reveals some interesting characteristics that should be highlighted as important aspects of the newest generation joining the professional world. It shows that Generation Y is looking to enter into the professional workforce and have been eager to jump onboard than before. The demographics in the study, 18-29, show that there are many college graduates lumped in seeking professional work, which is great news.

In the study, not mentioned in the news article, the Gen Y population demonstrates the entrepreneurial spirit. That finding suggests that this particular generation seeks ways to build services and products on their own rather than work for a company. The study also mentions that nearly 2/3 of the surveyed group avoid disclosing their employer on Facebook. This evidence supports the notion that Facebook is a social network intended for personal use among friends and family. However, the study reviewed data from Facebook. If the study showcased LinkedIn, it may paint a rather different picture of the state of professional social media for the Generation Y population.

Is Gen Y Taking Social Media Seriously?

Yes. And no. For those seeking professional careers, they are putting themselves out there through the use of blogs, social media, and websites. They are promoting themselves using every avenue possible. For example, I am on all the social networks, I write this blog, I also have a couple other websites out there. I am constantly networking with professionals on these networks and promoting myself. So far, it has produced successful results.

On the flip side, there are people who are not on professional networks and are missing out on employment opportunities. There is great potential to professionalize Generation Y through the use of Twitter, LinkedIn, and Google+. We simply need to find the right formula to demonstrate our seriousness in the workforce and show that we can play well in the big leagues too.

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.