Case Study 3. Software Installation Guide
 |
Client
Royal Mail Group plc
The RequirementTo write and present an Installation Guide for computer software. This manual was part of a paper-to-computer exercise to recover text and illustrations from 20 bound volumes, using scan and OCR to recover the source material.
The document is long and must be navigable. Customisation is required during software installation and detail must be visible.
The manual is most likely to be used on-line but may be printed by certain users.
All techniques used must be available to client's in-house staff. All resulting documents must be able to be maintained in-house during the life cycle of the equipment (up to 15 years).
Result must conform to existing house style.
Method-
Text is formatted in Microsoft Word, to existing in-house style
-
Illustrations are created in Corel Draw and Paint
-
Illustrations are linked to Word text and sized, as appropriate.
-
Automatic Tables of Contents/Cross-references etc. are installed.
-
Word document is post-processed to PDF format for distribution
-
Single source document (MS Word)- easy maintenance.
-
Formatted for effective display on screen or on paper.
-
PDF distribution format allows zoom in/out for accurate display.
-
Prints to paper exactly as seen on screen.
-
Documents are navigable using point and click on hyperlinks (in blue).
The thumbnails below link to the original, high quality Adobe PDF files.
Note:
Any hyperlinks in the examples are for illustration only, they cannot
function.
|
Page showing client-approved front cover of document, including non-printing icon for hyperlink to Table of Contents. |
Table of Contents with each entry being a hyperlink to the relevant topic. Optional 'return' links bring the user back to the TOC. |
|
|
 |
|
Cross-references in blue contain hyperlinks to the target topic. Screen-shots (in this case containing specific customisation data) can be 'zoomed' for clarity. |
|
 |
|
|
Siret: 398 366 617 00015