Adaptive Software Solutions

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 cont

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 ar