Skip to main content

Planning a User Guide - Part 4/5 - Get Your Toolbox Together


Photo by Fleur Treurniet on Unsplash


In the previous post, I had discussed how to organize the team for creating your software's user manual. With the team ready, the next step is to select the tools.

Working with the right technical writing tools is as important in technical writing as it is in building software. The right tools will help you be more organized, productive, and accurate in your work. 

In software, we use an IDEs, testing tools, and version control tools to manage our work. In technical writing, at a bare minimum, we use a content authoring tool, an automated grammar checker, and visual tools to assist us in our work. 

I'll discuss various tools that are available in the market, link to comparisons, and share my opinion to help you make the right choice.

Help Authoring Tools

A Help Authoring Tool (HAT) offers several features that go beyond simple word processing software for writing technical documents. HATs support publishing the content in multiple formats, responsive design for different devices, indexing, single-sourcing, and context-sensitive features. 

Here are a few popular Help Authoring Tools:
  1. Adobe RoboHelp
  2. Author-it
  3. ComponentOne Doc-To-Help
  4. EC Software Help and Manual
  5. MadCap Flare
  6. Dr. Explain
Even though HATs are useful, I have yet to come across a small/mid-sized software company that uses them. It's because, at most small companies, it is the developers who write the first version of their technical manual. Using a HAT cuts on two sides: first the company has to pay a rather steep fee for using the HAT, and second, the developers will have to invest time in learning the software. Both money and time are at a premium in small organizations and their requirements are usually sufficiently fulfilled by MS Word or Google Docs.

It doesn't mean that HATs are not useful. If you feel that the features that a HAT offers will add significant value to your product, then I recommend that you read through the posts I have linked below to get an understanding of how they compare before making a purchase decision.


Automated Grammar Checker

An automated grammar checker is an invaluable tool for all writers. There are several automated grammar checkers on the market. Most have a freemium model where the free version at the very least corrects punctuation errors and basic grammatical mistakes and the paid version corrects more advanced grammatical issues and other issues related to sentence construction, readability, and plagiarism. Some software will also help you enhance your vocabulary - which is super awesome.

I personally use the free editions of both Grammarly and ProWritingAid.

Grammarly is great at detecting punctuation and basic grammatical mistakes. Also, Grammarly's free Chrome plugin totally rocks. It's a huge help when I compose emails in the browser or when I write blog posts. The only downside is that the plugin does not support Google Docs.  

ProWritingAid's free version which runs on a web interface is very intuitive and easy to use. It gives a great summary of the analyzed text, offers readability checks, checks for cliches, overused words, and several other features. Unfortunately, they include the browser plugin only in the paid version.

I suggest that you begin with the free versions of ProWritingAid and Grammarly. They may be all you need for working on a technical manual. 


Visual Tools

From the perspective of writing software user manuals, the most important visual tools are screen capturing software (to capture screenshots) and image editing software (to do minor edits to the screenshots). 

There are many free as well as paid screen capturing software available on the market. Here's a list of ten best screen capture software for 2018. I personally use the free version of Jing and am very happy with it.

Once you have the screenshots, you might want to do minor edits to highlight certain parts of the screen. Jing (and other screen capture software as well) will allow you to make highlights, circles, etc, but I don't like the quality much. I prefer to use a proper image editor. 

Online image editors work best since they do not require installation and some even have team features. Here's a list of great online image editors.
Labels:

Comments

Post a Comment

Popular posts from this blog

Running your own one person company

Recently there was a post on PuneTech on mom's re-entering the IT work force after a break. Two of the biggest concerns mentioned were : Coping with vast advances (changes) in the IT landscape Balancing work and family responsibilities Since I have been running a one person company for a good amount of time, I suggested that as an option. In this post I will discuss various aspects of running a one person company. Advantages: You have full control of your time. You can choose to spend as much or as little time as you would like. There is also a good chance that you will be able to decide when you want to spend that time. You get to work on something that you enjoy doing. Tremendous work satisfaction. You have the option of working from home. Disadvantages: It can take a little while for the work to get set, so you may not be able to see revenues for some time. It takes a huge amount of discipline to work without a boss, and without deadlines. You will not get the benefits (insuranc...
10 comments
Read more

Testing Groovy domain classes

If you are trying to test Grails domain class constraints by putting your unit test cases in the 'test/unit' directory, then your tests will fail because the domain objects will not have the 'valdate' method. This can be resolved in two ways: Place the test cases inside test/integration (which will slow things down) Use the method 'mockForConstraintsTests(Trail)' to create mock method in your domain class and continue writing your test cases in 'test/unit' What follows is some example code around this finding. I am working on a Groovy on Grails project for a website to help programmers keep up and refresh their skills. I started with some domain classes and then moved on to write some unit tests. When we create a Grails project using grails create-app , it creates several directories, one of which is a directory called 'test' for holding unit tests. This directory contains two directories, 'unit', and 'integration' for unit and ...
11 comments
Read more

Planning a User Guide - Part 3/5 - Co-ordinate the Team

Photo by  Helloquence  on  Unsplash This is the third post in a series of five posts on how to plan a user guide. In the first post , I wrote about how to conduct an audience analysis and the second post discussed how to define the overall scope of the manual. Once the overall scope of the user guide is defined, the next step is to coordinate the team that will work on creating the manual. A typical team will consist of the following roles. Many of these roles will be fulfilled by freelancers since they are one-off or intermittent work engagements. At the end of the article, I have provided a list of websites where you can find good freelancers. Creative Artist You'll need to work with a creative artist to design the cover page and any other images for the user guide. Most small to mid-sized companies don't have a dedicated creative artist on their rolls. But that's not a problem. There are several freelancing websites where you can work with great creative ...
Post a Comment
Read more