Standard sections in software user assistance

Print topic Print topic Previous topic  Next topic

For software user assistance, use the following catalog of standard sections as a checklist.

Depending on your particular product, some sections may not be necessary, and you may be able to omit them. When creating online help, also omit the typical components that only make sense in printed manuals, such as a front cover, a back cover, a table of figures, and a table of tables.

Typically, the sections appear in the order given below.

If you provide more than one document, the sections can go into different documents.

Expand /Collapse All Subsections

Front cover (title page)

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Legal information (imprint)

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of contents

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

See also Designing: Table of contents area layout

See also Designing: Table of contents page layout

Preface

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

What’s new

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Installation

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Getting started

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Concepts

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Procedures

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Reference information

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Troubleshooting

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Service and customer assistance

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Glossary

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Software license acknowledgements

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

End user license agreement (EULA)

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of figures

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Table of tables

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Index

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

See also Designing: Index area layout

See also Designing: Index page layout

Room for notes

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm

Back cover

You are using the trial version of the Technical Documentation Copy and Paste Kit. To be able to view this topic, please buy the full version here:

http://www.indoition.com/en/products/copy-and-paste-kit-buy.htm