▪Make document titles as short as possible. ▪Include the product name in the title. ▪If you begin a title with a product name, add a line break after the product name if possible. ▪Create a title that clearly communicates the dominant information type within the document (concepts, procedures, reference). ▪When applicable, clearly state as part of the title for which audience (user group) the document has been designed. ▪When possible, choose a common document type so that users know what to expect (see lists of typical publications at the end of this topic). ▪If you supply only a single document along with your product, the need to communicate the document type, information type, and audience is less important. In this case, you can also choose a more engaging title. For example, you could call a manual Driving your FancyCar instead of FancyCar Owner’s Manual. ▪Include the product version number on the title page, but don’t make it part of the title. ▪Name all of your documents in a parallel manner.
No:
|
DemoProduct Installation Manual
DemoProduct User’s Guide
DemoProduct Reference
|
Yes:
|
DemoProduct Installation Manual
DemoProduct User Manual
DemoProduct Reference Manual
or:
DemoProduct Installation Guide
DemoProduct User’s Guide
DemoProduct Reference Guide
|
|