Case Studies

Provided Technical Authoring Services, developing an HTML online help system, for a major software project.

The services provided included:

• co-ordinating the client’s business users writing the business processes
• generating keyword indexes
• producing regular builds of the on-line help during the project’s lifecycle

We provided Technical Authoring Services to update the User Manual for the client's Messaging Software suite. The update was necessary to document the enhanced functionality provided by the latest version.

The task entailed:

• liaising with the client's Subject Matter Experts
• running the new software
• capturing screenshots
• writing procedures and descriptive text for the new features

Provided Technical Authoring services to the Infrastructure teams:

These services included:

• creating and maintaining n-tier architecture infrastructure technical documentation and diagrams for a variety of new and existing systems, to required standards, for multiple services concurrently
• liaising with other technical areas to ensure produced documentation met their requirements and reviewing other documents to ensure information is sufficient to meet client needs
• setting up Word document standards, styles and formats, conforming to HMCE standards

Provided Technical Authoring and Project Management Services to a project which was converting and editing 3G, GSM, and UMTS network switch manuals from Word to XML.

This involved:

• managing up to six product/technology streams concurrently
• co-ordination of Technical Publication staff (authors, editors, illustrators
• training the supplier’s authors in China
• making visits to India to initiate the project and to brief the outsourced project staff

We provided Technical Authoring Services to create the setup and administration user guides for an e-marking application.

The task entailed:

• liaising with the client's Subject Matter Experts
• running the new software
• capturing screenshots
• defining style elements
• writing procedures and descriptive text for the new features
• developing modular process for future builds and inclusion of additional features

We were engaged to update the client’s Internet website to improve its appearance and to update the content.

The task entailed:

• creating a fresh ‘look-and-feel’ for the site
• sourcing photographs and other graphical elements
• updating textual content for the new site in both English and Italian

We provided Technical Authoring Services to create and modify technical specification and programming user guides for complex system-on-a-chip TV and set-top box microchips.

The task entailed:

• liaising with the client's Subject Matter Experts
• updating the content of existing manuals
• creating new manuals
• developing XML-based reuse and single sourcing solutions.
• developing multiple manuals based on a generic ship type using conditional tagging.

We provided Technical Authoring Services to create and modify hardware manuals for data at rest encryption products, and online help for software applications for managing encryption hardware, including the user and maintenance documentation for a leading-edge UAV system.
The task entailed:

1. liaising with the client's Subject Matter Experts
2. updating the content of existing manuals
3. creating new manuals
4. developing complete lifecycle documentation
5. developing documentation processes
6. running and testing software products and identifying additional features
7. capturing and creating screenshots
8. photographing hardware and processing images
9. defining style elements
10. developing modular process for future builds
11. developing RoboHelp-based reuse and single sourcing solutions

Preparation of design Substantiation Reports for the control boards in a prestigeous, high profile military (Royal Navy) project .

The services included:

• rationalising and enhancing document styles to produce a consistent output style.
• extraction of data from multiple sources within DOORS and networked file storage.
• Liaising with SMEs to verify and validate the data.
• writing Design Substantiation Reports .
• enhancing and correcting technical drawings and illustrations.
• updating source content in DOORS.