Procedure

Customer Driven Solutions Limited

SWLC-PRO-001

Build procedure for Help Systems

Owner:

Bruce McNaughton

Approved By:

Bruce McNaughton

Issue Date

24/02/2018

Signature:

Bruce McNaughton

Re-Approval Date:

24/02/2020

Status:

Approved

 

Applicability

 

All revised Help System Releases.

 

Procedure

 

Follow the steps to create or update the HTML5_Top system or create a Help System (CHM) for a ChangeAide Plus distribution.

 

Step

Description

Records

Update the version of the Help System

Update and record the version of the help system in the variables section.

Version:

Record the creation date

Record the date of creation (and update the date variable).

Date:

Create a new release history topic

Create a new release history topic for this version. (Copy and Paste the previous version and update). Add details of changes.

Check:

Update the RSS Feed XML file

Update the RSS Feed XML file with pointers and keys for new revision history topic. (Use XML Spy to edit).

Check

Update the snippet to point to latest revision history file

Update the snippet to update the hyperlink that points to the latest Revision History Release Topic.

Check
Add snippet to the current version to link to latest version. Add a snippet to the current version of the file so it will link to the latest revision history topic. (Copy and paste the line from a topic that contains the snippet). Check

Add Release History topic to the TOC

Add Release History topic to the TOC

Check
Update link to latest release Update the hyperlink in the Release History Intro topic Check
Update EXE link in dnload.js Update the link to the ChangeAide.exe file. in the Javascript file. Check
Add or update any topics Add or update any topics for this release Check
Add or update any examples Add or update any example projects or files. Check
Make any changes to the TOC Make any changes to the TOC. Check
Build the HTML5_Top version and test Build the HTML5_Top version and test Check
Update Alias file if necessary Update the ChangeAide Alias file if necessary (may need to rebuild). Check (optional)

Transfer the HTML5_Top version to the server

Transfer the HTML5_Top version to the server

Check
Build the CHM version Build a CHM version if the ChangeAide Plus is to be published. Check

 

Tools Required

 

Flare (and Analyzer)

Mimic

SecureFX (Sync the files from PC to Server)