If the source is the same for both printed and online documentation, use all lowercase for all index entries except those words that require capitalization and See and See also references.
Tip from MSTP 66
October 7th, 2011 by Trainingteam · No Comments
→ No CommentsTags: The Writers Block
Tip from MSTP 65
October 6th, 2011 by Trainingteam · No Comments
Use the index style in the same design template you used for your document. The font should be the same as that in the book, but in a smaller point size.
In general, do not use special character formats such as bold, monospace, or italic for entries. Use italic for cross-references.
→ No CommentsTags: The Writers Block
Tip from MSTP 64
October 5th, 2011 by Trainingteam · No Comments
Separate multiple page references with commas. Separate page ranges with en dashes. It is all right to use hyphens to indicate page ranges instead if you need to conserve space. Do not abbreviate page references.
If possible, avoid long multiple page references listing consecutive pages. A page range might better represent the topic. Likewise, avoid chapter or section length page ranges if the topic is clearly shown in the table of contents. Users prefer to be able to find more specific information.
Good Example:
paragraphs 24, 47, 126–130
deleting 72–76
formatting 87
Bad Example:
paragraphs 24, 47, 126, 127, 128, 129, 130
deleting 72, 73, 74, 75, 76
formatting 87
→ No CommentsTags: Authoring tools · Best Practices · Career · Content Management · English and Grammar · Faculty · Guest Post · HR / Training · Knowledge Management · Miscellaneous · Online Technical Writing · Subject Matter Experts · Technical Writing · The Writers Block · Trivia · TWB OnCampus · Writing Resources
Tip from MSTP 63
October 4th, 2011 by Trainingteam · No Comments
Avoid the use of prepositions to begin subentries. In some cases, however, prepositions can clarify relationships. Do not use articles to begin subentries.
Do not repeat a main term in the subentry.
Good Example:
Pointers
far
function
Bad Example:
pointers
far pointers
function pointers
→ No CommentsTags: The Writers Block
Tip from MSTP 62
October 3rd, 2011 by Trainingteam · 1 Comment
For every main entry you create, make a subentry. You might have to delete those subentries later, but that is easier than having to add them.
Consider as subentries these generic terms, especially when a topic is covered in various places in the book: defined (to refer to a term), described (to refer to an action), introduction, and overview.
→ 1 CommentTags: Authoring tools · Best Practices · English and Grammar · Faculty · HR / Training · Miscellaneous · Subject Matter Experts · Technical Writing · The Writers Block · Writing Resources
Grab your CD
