8.4. Composition Tips

This section contains usage tips based on situations the Fedora Documentation Project editors have encountered in the past. You should read and understand these examples to improve your own documentation. The Fedora Documentation Project editors welcome additional examples.

8.4.1. Active Voice

Always use active voice, except when it is awkward to do so. The tutorial tells the user how to accomplish a task, and should give instructions clearly and concisely. Avoid using "must," "need to," and the like. These words are redundant in a tutorial, since the reader assumes you are outlining necessary steps to accomplish a task. Also avoid using "maybe," "might," and other words that indicate you are unsure about the subject matter. Your tutorial should cover a subject authoritatively. The reader should never be concerned about unknown effects of following the tutorial.

The yum update command must be run.

You might want to run the yum update command.

Example 8.13. Incorrect: Passive voice

Run the yum update command.

Example 8.14. Correct: Active voice

8.4.2. Present Tense

Write in the present tense. A good rule of thumb is that the words "will" and "shall" are almost never needed in describing what the user should do or see. They add unnecessary length to sentences and can confuse translators. They are also often indicators of passive voice; refer also to Section 8.4.1, “Active Voice”.

The application will display a list of target files.

A list of target files will be displayed by the application.

Example 8.15. Incorrect: Future tense

The application displays a list of target files.

Example 8.16. Correct: Present tense

8.4.3. Narrative Voice

Do not use the first person "I," "we," or "us" to refer to yourself the writer (whether including the reader or not), the Fedora Documentation Project, the Fedora community, or any other group. Do not refer to users with a third person pronoun ("he," "she," or "he or she") or the word "one." It is acceptable to refer to the reader with the second person pronoun "you."

As described in the last section, I always run up2date before configuring the Samba server.

If the user needs to back up his or her files, s/he should use the tar or cpio command.

Example 8.17. Incorrect: First or third person

Refer to the section on up2date before configuring the Samba server.

If necessary, users can back up files with the tar or cpio command.

Example 8.18. Correct: Second (or no) person

8.4.4. Negative Words

Avoid negative words when possible, since they give documentation an overly dogmatic tone. The word "avoid" is useful for this purpose. Note that contractions are often used for negative words such as don't or can't. Refer to Contractions.

8.4.5. Uncertainty

Avoid overuse of "typically," "usually," "most of," "many," and the like. While occasional use of these constructions is acceptable, overuse reduces the authority of your documentation. The documentation should adequately cover a stock installation of Fedora Core. It is impossible for a tutorial-length document to cover every possible configuration scenario. Address the most common scenarios and note discrepancies only as required.

8.4.6. Redundant Coverage

Avoid covering redundant material, such as how to update a Fedora Core system. These overarching topics may be covered in other tutorials. Writers frequently violate this guideline because they feel their tutorial is not long enough. Keep your tutorial from wandering off-topic. Instead, refer the reader to a separate tutorial whenever possible for complete coverage of that topic.

8.4.7. Self-referential Value Judgments

Avoid statements such as "One of the most important things to do is XYZ." If the procedure is important, the reader already expects it to be in your tutorial. The converse is also true: If a procedure appears in your tutorial, the reader expects it is important. This is especially true if you use a whole section for the procedure in question. Merely state, "Do XYZ." Then elaborate as required. If the whole section concerns how to do XYZ, leave this sentence out entirely. Refer also to Golden Rule 4: Be objective.

8.4.8. Precision of Language

Use precise words for actions users should take. Do not instruct users to "go" to a selection, or "find" a menu.

  • Go to the Main Menu -> Foobar

  • Find the option labeled Search

Example 8.19. Incorrect: Imprecise wording

  • From the Main Menu, select Foobar

  • Select the Search option

Example 8.20. Correct: Precise wording

[Important]Do Not Discriminate Against Non-GUI Users

If you are writing about a GUI-only application, you may use "click" freely. If you are writing about an application that has a text-mode interface, use "select" instead as shown above.

8.4.9. DocBook Tips

This section contains tips on how to use DocBook tags more effectively in your documentation.

8.4.9.1. Admonitions

Avoid overuse of admonitions. Keep admonitions short and effective by using only the most important material inside the admonition. Move any background material required to explain the admonition statements outside the admonition. Use a short but descriptive title for an admonition. Use title case for the admonition title.

[Warning]Use sfdisk to check input

The sfdisk command accepts a script file as standard input to set up partitions on a hard disk. Sometimes sfdisk will simply reject an erroneous input file. In other cases, it will use the input verbatim, writing an incorrect partition table to your disk. Always use the sfdisk -n command to check your input file before writing to the disk.

Example 8.21. Incorrect: Lengthy admonition

The sfdisk command accepts a script file as standard input to set up partitions on a hard disk. Sometimes sfdisk will simply reject an erroneous input file. In other cases, it will use the input verbatim, writing an incorrect partition table to your disk.

[Warning]Check Input

Always use the sfdisk -n command to check your input file before writing to the disk.

Example 8.22. Correct: Brief admonition

Avoid punctuation in titles for sections or admonitions, except for commas only where demanded. Use a title that says something about the admonition comment, such as "Reboot Required," instead of simply using the admonition type for a title ("Note").

Follow the capitalization rules for headings in the title of an admonition.

8.4.9.2. The <replaceable> Tag

If your documentation formally states a specific value will be used as a convention, do not use the <replaceable> tag in your text or examples.

8.4.9.3. XML Entities

Use the entities provided by the Fedora Documentation Project. These entities are found in the common/ folder in the fedora-docs distribution. (Refer also to Chapter 1, Getting the Files.) For instance, do not use abbreviations such as "FC2." Instead, use the predefined entities "&FC; &FCVER;," which produces the text "Fedora Core 4."