Businesses large and small often use in-house products that aid in productivity for the entire company. These in-house products could take the form of virtual software or physical hardware, and they are used in a wide variety of industries. When a company makes its own products, however, it is key that every step of the development process is thoroughly documented. If there is limited technical documentation about an in-house product, then updating that product in the future, or teaching new employees how to use it, will be very difficult. Essential Data Corporation’s technical writers have helped many companies compose thorough and up-to-date documentation for their in house products, both for simple and extremely complex cases.

Client Need

One of the more complex clients whom we have helped navigate this scenario is an online mortgage originator. This company had created their own online approval process for originating mortgage loans, and this software had been in use for many years. Unfortunately, this product was created by the company’s in-house development team of three people, and no one else at the company had the technical expertise to understand the details or specific machinations of the software. Understandably, this issue worried the company. What if one of these in-house developers left the company? What if the developers use their knowledge as leverage against management or executives? These questions were combined with additional concerns about the difficulties of training new employees due to the lack of technical documentation for the software.

EDC Solution

So, how was Essential Data able to help this client? First, Essential Data provided two technical writers and one instructional designer to work with the in-house development team to fully analyze the company software. Then, the technical writers created a tutorial for the software that could be used to train employees. The result of this collaboration was accruing both technical documentation for future software development and updates, as well as user-friendly manuals for day-to-day usage.

Benefits for the Client

In the end, the true benefit of Essential Data’s technical writing and documentation services was that the software no longer exists in the heads of just three people, but in a fully documented form that other people in the company can follow and understand. This not only made the software easier to use in the present, but also gives the client greater flexibility in the future. Across the board, Essential Data’s work improved software use and understanding, boosting productivity, clarity, and company morale.

Written by Jeffrey Pinsker-Smith