Search ☰ Menu
888-235-3231
×

Popular Searches

Technical Writing Documentation Services Training Methods User Documentation Consulting Services

Software Documentation Solutions

Critigen Case Study

Software Documentation Solutions

Critigen

Challenge

Critigen is an information technology services company that developed a software platform to help companies integrate geographic mapping data with other business software applications, such as asset management, work management, field data collection, and other applications that leverage location information.

Critigen knew they faced three key documentation challenges that they expected to be addressed by a robust solution:

Solution

The team at InfoPros began by performing an analysis to gain a better understanding of Critigen’s software platform, the software development environment, and the needs of those using the software. The analysis findings were critical to developing an effective documentation solution that would meet Critigen’s needs.

A key factor was that Critigen was using two-week sprint cycles to drive Agile development. The software platform was in a state of ongoing improvement, so InfoPros knew that keeping the documentation up to date meant keeping pace with the software development team. InfoPros established the documentation effort as an integral part of the software development life cycle. This approach immersed InfoPros into the development environment and fostered a stronger partnership between the two groups.

By doing the analysis, InfoPros identified three main types of information that needed to be addressed by the documentation.

To support content development, InfoPros implemented several documentation tools. These tools complemented Critigen’s software development publishing framework, meaning that documentation builds could be stored and packaged with Critigen’s existing software publishing tools.

A key factor in making the Critigen-InfoPros partnership a success was the level of integration between the Critigen stakeholders and the InfoPros project team, which was comprised of a project manager, solutions architect, technical writer, editor, and technical illustrator. The InfoPros project manager was a key constant from the beginning, facilitating workflow management, managing the budget, and providing status reporting to Critigen every step of the way. Individual InfoPros team members were brought into the project as needed, in order to keep each deliverable on schedule and on budget. With this approach, Critigen did not have to worry about staffing needs to meet peaks and lulls in their software development life cycle. Plus, Critigen was able to take advantage of expertise about documentation approaches, tools, and techniques from the InfoPros team—skills and experience that would be hard for them to replicate internally.

Result

Critigen saw real results in a very short time:

Working with InfoPros meant that Critigen could focus on building its software without worrying about documentation.