Help Documentation (Flare)

Technical Writing Project, Help System Documentation for software application. Environment: Madcap Flare 5 Help doc outline: Table of Contents List of Figures/Images Overview Installing - using Windows MSI License - using license utility sub-menu GUI Element Detail, all visible user-interfaces Interfaces - functionality, file formats, caveats, notes Adobe Reader 3D menu help Terms-Glossary Index We intend to use Flare as the primary authoring tool, this is strongly preferred. It may also be possible for you to author using Adobe RoboHelp, but we expect a big discount on price since we will have to import and clean up in Flare. This is a fresh start, there is no existing help for this new application. The functions behind the buttons are described in a number of other technical documents, but not organised for end-user help. The application has a simple GUI organisation. It has one main window, with simple File and Help menu at the top. Inside the application windows are 5 tab panels. There are a further 5 dialogs that may be openned at certain points. In total there are approximately 50 user interface elements (buttons, choice selectors, etc). We require a very professional look to the help, well designed framework that can be maintained for years. output Targets are #1 PDF, #2 Windows Help (.chm), #3 Web Html. The time frame is 1 - 2 weeks. The software is just now entering beta test. The help must be written between now and final release. A full zip of the Flare project file directories are to be sent periodically during the writing project for review and amendment. All copyright and ownership are with buyer. The application is built on top of libraries that have technical documentation and xml specifications. The help should have screen grabbed images for illustration. You will be required to create these images, using a trial license of the application. ## Deliverables Madcap Flare 5, possible alternative RoboHelp