Product Documentation

Product Documentation

Did you ever try to read the user guide for an appliance and find that it wasn’t very helpful? Perhaps it was written in English but not very good English. Perhaps the English was good but it didn’t answer your question. Or perhaps there was no user guide at all, just a document with warnings such as “Do not use this appliance in the bathtub.” Saiff Solutions can help. If the company that makes the appliance hired us, you would instead be using a well-written, helpful guide that clearly shows you how to do what you want to do with the appliance.

Saiff Solutions can develop excellent product documentation for any kind of product. Whether it’s a toothbrush or a DVD player, a surveying tool or a tire jack, clear documentation can make the difference between effective use and complete failure for the user.

Excellent product documentation clearly answers questions such as:

  • What can I do with this product?
  • How will using this product benefit me?
  • How do I do what I want to do with this product?
  • How do I tell if this product is working correctly?
  • How do I tell if this product is not working correctly, and exactly what is wrong?
  • What should I do if this product is not working correctly?
  • What are the limitations of this product?
  • What else can I do with this product?
  • Why is this product a better solution?
  • How can I upgrade or update this product, and why should I do so?
  • What maintenance is required for this product, and how do I perform that maintenance?
  • How do I install or uninstall this product?
  • Are there special considerations for moving this product?

In order to create excellent product documentation, the technical writers at Saiff Solutions will need to answer questions such as:

  • What types of people, in what types of roles, will use this product?  For example, will managers in restaurants use the product, or cashiers in grocery stores?
  • In what contexts will people use this product?  For example, will home chefs use the product in their kitchens, or will landscape architects use the product in their offices to design large outdoor spaces?

 

Blog Archives

Latest Facebook Posts

Barry Saiff shared Global Coherence Initiative's photo to the group: Philippines Technical Writers. ... See MoreSee Less

Hoping you have many heart moments today… and always…

View on Facebook

Saiff Solutions In The Media

- TechWhirl
- Nominated for 2015 Rice Bowl Asean Start Up

Click image to enlarge

Testimonials

“Barry [Saiff] truly is a force of nature – he is a consummate professional with deep technical expertise when it comes to technical writing which lets him just “get it” right out of the box. Barry pairs very strong writing skills with the ability to easily speak both “business analyst” and “software engineer” in the same meeting. Barry was the lead information developer for my product at Symantec, and I had the utmost confidence in his abilities and work ethic. On top of all that, Barry has a wonderful sense of humor and an infectious laugh that can transform the work environment in an instance. I strongly endorse Barry’s many talents and would welcome working with him again in the future.”

Angelos Kottas
Principal Product Manager, Symantec
December 17, 2010

Read more testimonials here.