Software Documentation

Software Documentation

While Saiff Solutions can document almost any kind of product, our special expertise is in software documentation. Our founder, Barry Saiff, has over 26 years experience writing and editing software documentation for companies in the United States.

Writing excellent software documentation is an art. It is not merely translating technical jargon into terms everyone can understand. The writer must learn how to use the software product, and learn about the details of all the features. Then the writer must design documentation that provides the user with exactly the information the user needs, in a clear, well-organized manner that makes sense to the user. The user must be able to easily find the information that will help them accomplish their tasks with the software.

Given the proliferation of platforms on which people use software – computers, tablets, mobile phones, company networks, the Internet, etc. –  users need to be able to access platform-specific documentation in the format and delivery method of their choosing. The process of technical writing has evolved to accommodate this diversity of use, via the development of content strategy and topic-based authoring.

Saiff Solutions has expertise in the development of topic-based documentation. Instead of writing manuals per se, our writers can write a series of stand-alone topics that cover all the procedures and information that each user needs on each platform. The same topic can in many cases be used for multiple purposes. Topics can be assembled into manuals, online help systems, online knowledge databases, or any other required deliverables. If your company requires documentation that covers a variety of platforms and types of users, and you are new to topic-based authoring, we can help you to understand its benefits and guide its implementation for your products.

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] has extensive experience both as a manager of technical writers and as a writer. As a manager, he is fair, encourages innovation, and is open to divergent points of view. As a writer, he can grasp very complex concepts and explain those concepts to end user through administrator audiences. Additionally, he has expert knowledge of all components of the documentation process, including corporate style guides, editing, writing, working with localization, and production. Barry is very much a people person and wherever he goes, he cultivates a large network of friendly yet professional relationships. He’s worked successfully with both on-site subject matter experts as well as those across the world. During my time working with Barry, he’s run a number of successful efforts to improve the usability of documentation. In one such case, he recruited a cross-functional team to overhaul the documentation based on the recommendations of this user-facing group of subject matter experts.”

Steve Anderson
Principal Technical Writer, Symantec
December 16, 2010

Read more testimonials here.