2003-04-23

Editing documents in MSWord?

Be sure to check the document properties, File => Properties

These can often show information that is not consistent with the content. If the information was borrowed/stolen from someone then it may also show the original author.

2003-03-05

Integrated development

We hold these things to be self evident:
Any manuals and online help (inc. those for software) should be created using an integrated development process.
The manual and the product it supports should be entirely consistent with each other. The content of the manual should be focussed on the functions of the product.
To do this the documentation must start with the functional specifications and be developed alongside the product.

2002-03-01

Document conversion problems in HDK

To find the error, (use a copy of the document) make it into two documents and see which half crashes.
Remember to put a Heading 1 at the start of the second half.

Reboot and then split that document in half until you find the problem. Also watch the compile process for clues on which topic has the problem.

Once you find the topic with the problem, go to the original document and copy the text to Notepad then back. This will clean up the code. If what you find is a table, select the table and convert it to text then back again to clean up the table.

Sometimes the problem is with an imbedded graphic, normalise the graphic in some way and then reinsert it.

2002-02-06

HDK features that are also in XDK:


  • a number of table of contents options (more in v3.6)
  • Styles, HDK generates a CSS based on the MSWord paragraph and character styles
  • projects can process a "header" file or you can mock one up to control the names of the output HTML pages
  • HTML pages can be split out of a single Word document using paragraph styles
  • projects can include multiple Word documents.

@winhelp3 on Twitter