Technical Writer at Schneider Electric

"The end result was a high quality document that provides the right level of content for our users"

“Schneider Electric has used Craig Wright for a number of documentation projects. The two main projects are:

  • Creation of DNP3 WITS user guide for the ClearSCADA DNP3 WITS driver

    This was a new guide which was included in the main ClearSCADA help. This DNP3 WITS ClearSCADA driver is an extension to the core DNP3 driver and provides extensive functionality for the UK water distribution market. However the WITS driver is very different to most of the existing drivers in ClearSCADA, so a lot of content was completely different to any of the existing guides.

    Craig contacted and dealt with key technical staff in the company to gain a thorough understanding of the WITS driver and what was required for the guide. Craig then designed the structure that the document should follow and added the content required. During the process Craig confirmed that all technical details were correct with the technical staff and was happy to get on with the guide without the need for close management.

    Craig would keep us informed of the progress on a regular basis and alert us to any issues that might cause a slip of the delivery date. Due to the scale of the project we had to allocate a few days extra in the plan to allow the guide to contain the right level of information. The end result was a high quality document that provides the right level of content for our users.

  • Conversion of documentation from legacy tool set to Mad Cap Flare

    Craig played a key part in investigating and finding the best way to convert our documentation suite from Adobe Framemaker to MadCap Flare. He tried out the different ways of importing the documentation into Mad Cap Flare and described the pros and cons of each approach. Craig worked closely with the other technical authors and myself during the conversion process. Craig also would contact MadCap support when required to deal with issues that arose during the process.

    Ultimately there was no one process that allowed the documentation to be migrated without issue. So after the conversion took place Craig put a lot of effort into fixing up the MadCap Flare sources, a lot of the time editing the raw XML, to get the documentation into a stable state post import. Craig also produced notes on the Flare processes to aid other technical authors on the team. He also worked on setting up the style sheets for the look and feel of the documentation in Flare. During this whole process he also updated some of the guides to reflect updates in the product as well.

    The help system for ClearSCADA now looks and feels modern and up to date, Craig’s hard work contributed to this.” - Paul New, Software Development Manager, Schneider Electric

To find out more, see the Schneider Electric case study.