Experience
| Home |
| Documentation |
| KM Consulting |
| Training |
| Experience |
| Methodology |
| Downloads |
| Endorsements |
| About Us |
Wordware has many years of experience in documentation and related disciplines. We enjoy strong long-term business relationships with many organisations. Seventy per cent of our projects represent repeat business from existing clients.
Our clients tend to be larger organisations with offices geographically dispersed throughout Australia. They cover a broad range of enterprises, financial services, industries and government organisations at federal and state levels.
Large-scale Projects
The following are four case studies that involve industrial-strength documentation for large-scale projects:
• Case Study 1 - Government Regulation and Enforcement
• Case Study 2 - Major Defence Project
• Case Study 3 - Polar Orbiting Reception Satellite
• Case Study 4 - Weather Forecasting in South Pacific
Case Study 1 - Government Regulation and Enforcement
Wordware won the tender to facilitate, co-ordinate, document, edit and validate to a production-ready state 4,000 A4 pages of documentation for a Federal regulatory body. The project included transfer of skills in documentation planning, development, distribution and maintenance to its staff. It was completed in three phases:
• Phase 1 required Wordware to plan and document a process that conformed to IS09001 for controlling the production, distribution and maintenance of all controlled documentation produced by the regulators.
• Phase 2 was the writing, or editing and formatting, of approximately 30 manuals on a range of subjects. This phase also included intensive on-the-job training of regulatory personnel who were involved in writing draft documentation. To date, over 40 manuals have been produced.
• Phase 3 was a strategy for intranet-based and CD ROM delivery. The online manuals contain links from references in the documents to specific sections of regulations and other legislative instruments.
Wordware's current role is to maintain the hard copy and online documentation suite for regulation, administration and training based on a mutually-agreed Service Level Agreement.
Case Study 2 - Major Defence Project
Wordware won one of the largest Federal Defence documentation and training tenders let in Australia. It involved:
• Technical writing, editing, collation, production and printing of 128 technical manuals (approximately 10,000 pages) to Australian Defence Standard - DEF (AUST) 5629 - Production of Military Technical Manuals.
• Training needs analysis, training design, production of training courseware (50 modules), the provision of training aids, and the administration and delivery of maintenance training courses.
Wordware produced all the documentation required to support the field-level repair and maintenance of the entire project. The manuals were written to specified standards as required under the contract and incorporated in the Quality Plan. Training development was subcontracted, but we undertook the final edit of all training modules to ensure they met the required standard.
Case Study 3 - Polar Orbiting Satellite Reception System
A systems development company developed and implemented a polar orbiting satellite reception system for a Hong Kong based client. An integral part of the project was the Technical and User documentation. Much of the source material for the documentation existed only as software and hardware descriptions, pamphlets, flowcharts, mechanical, wiring and circuit diagrams, programmers documentation, etc. The contract specified the overall content of the manuals and that they be published in hard copy and soft copy (in both PDF and HTML). An additional requirement was that the completed manuals would also be used as part of the associated user and maintenance training. Wordware developed a blueprint for each manual, then researched and wrote the documentation by:
• Assembling the source material (managing and processing the document elements from the developers, and assembling and editing the modules)• Writing new material to fill gaps
• Distributing draft chapters for review
• Reworking reviewed material
• Preparing the documentation for publication.
The completed manuals were then published, printed and delivered on-site in Hong Kong in time for training and handover. When the company updated and upgraded the system documentation to produce a new three-volume manual set, Wordware was again asked to review the manual, check the table of contents, figures, etc. to make sure it was suitable for delivery to Hong Kong. Wordware completed the work on time and on budget, to the complete satisfaction of our client.
Case Study 4 - Weather Forecasting in South Pacific
A Federal bureau was engaged to provide systems and support for the upgrading of weather forecasting systems in the Republic of Fiji . The Fiji project involved provision of an extensive array of computer and communications hardware and customised software.
Wordware won the tender to provide all supporting user and system management guides for the project, in hard copy and online format. The project had three components:
• Implementing a Document Management System• Providing the documentation, which included designing and creating standard document templates, formatting existing documents to match the standard layout; writing the outstanding documentation (11 manuals), and producing relevant graphics to client specifications
• Providing the documentation online in HTML, creating the Web-based front end, and running and testing the initial HTML conversion.
The project involved a large team of writers and illustrators working for three months. Once again, Wordware's expert project management ensured that we successfully met the very tight deadline for delivery of the documentation components.
