Home/Expertise/By Solution/Technical Writing

By Solution

Technical Writing
Quality Assurance

To improve and enhance the software solution for better marketing, there was an urgent need for good user documentation. The development company lacked the resources and time to provide the professionally written technical documentation, so they turned to us for documentation creation.

After careful project analysis, our specialists found out that some documentation prepared by the development company was available. However, it was not possible to use it as it was for several reasons:

  • it was rather perfunctory and of a very draft quality;
  • it was based on one of the early versions of the system and outdated;
  • it was very fragmentary, incomplete and not covering all the functionality of the system or covering it incorrectly due to subsequent changes in the system.

As a preliminary step to the project, our specialists conducted project approval at the customer’s facility. We also established direct contact with the end customer to discuss any related matters as necessary. In the process of the approval and as a result of it the following was done:

  • a study of the features and the structure of the system was held;
  • the necessary working and time resource was estimated.

As a result, the process of working on the project was split into logical steps by structural parts of the system. To efficiently control the work, we allocated necessary time efforts to each part and the system as a whole. All relevant subject matters were discussed directly with the end customer. We produced detailed progress reports twice a week to all three parties.

Technologies used:  MS Windows 2000 SP4; .NET environment; MS SQL Server, Microsoft Office Word 2003 (editing); TechSmith SnagIt v. 7.03 (screenshot-making).

Efforts: 160 man-hours


Featured Case Study

The idea of the project was to re-develop the existing expense management system for a French company.

 

Web 2.0