Portfolio

Technical writing services for housing industry software solution

The a1qa technical writers created and managed help documentation for the software solution to assist housing authorities in understanding and using the system.
Documentation services
Real estate

Overview

a1qa tech writer is a clear communicator and takes feedback well. She readily modifies her writing after we discuss different perspectives or alternative ways to get the point across. She has a strong command of the English language. When we asked her to learn a brand new system to develop condensed training materials she quickly mapped out an efficient plan to accomplish this task. She fully accepts responsibility for tasks and hits every deadline. She willingly alters her schedule to make herself available for meetings and always attends with a ‘can do’ attitude.

A comprehensive software solution was elaborated for operations related to public and affordable housing in the USA. The software product was designed to automate business processes and to increase the operational efficiency of housing authorities.

Services offered

Documentation services

Project scope

The customer needed thorough documentation to cover all the system’s functions and particularities. The a1qa technical writing team was contacted to face the challenge.

Initially, the tasks of the a1qa team included preparation and management of context-sensitive help, How To’s, and FAQs. During the project, the technical writers were involved in developing training documentation to help end-users gain confidence in using the system.

The a1qa technical writing team plunged into the project and did everything to deliver top-notch results.

The customer was completely satisfied with the final results.

Challenges and solutions

A huge amount of new features delivered every sprint:

  • a1qa organized weekly meetings to review and register new features that should be addressed in the help documentation.

Various types of help documentation that required one unified style:

  • The team created a style reference guide that outlined formatting rules applied to the documents on the project.

Technologies & tools

  • Kayako
  • Microsoft Word
  • Microsoft Visio
  • Umbraco
  • Microsoft PowerPoint

Results

In numbers

3
years of project duration
90+
help files prepared
100%
compliance with the timeline

Get in touch

Please fill in the required field.
Email address seems invalid.
Please fill in the required field.
We use cookies on our website to improve its functionality and to enhance your user experience. We also use cookies for analytics. If you continue to browse this website, we will assume you agree that we can place cookies on your device. For more details, please read our Privacy and Cookies Policy.