One document or multiple documents?

Print topic Print topic Previous topic  Next topic

Always create individual documents instead of a single, all-embracing document if each document will be used separately. “Separately” in this context can mean that the documents are used:

by different people

at different times

for different purposes

In all other cases, carefully balance the pros and cons of both alternatives.

Expand /Collapse All Subsections

Advantages of having one all-embracing document

You only need to handle and ship one document.

Users have a single place where they can find all the information.

You can easily set links and cross-references between all sections of the entire documentation.

Advantages of having separate documents

If documents are used by different people, at different times, or for different purposes, each user is only presented with the small subset of information that he or she actually needs.

Documents are smaller and appear less daunting. This also creates the impression that your product is easy to use.

You can publish documents independently. You can publish each document as soon as it’s complete and don’t have to wait for the other sections to be finished.

You can update documents independently.

If multiple authors and translators are involved, it’s easier to manage the workflow.

As an option, it’s possible to ship only the most important documents in printed form and to supply all other documents electronically.

As an option, it’s possible to translate only the most important documents and to supply the remaining documents in English.


Layer information

How should you name your documents?