5.3 -- Instructor's Golden Rules

Style Rules

1. Choose a small set of abstract terms (e.g., state, transition) and then carefully define all other terms ultimately in terms of the abstract terms.
2. Always start each chapter, and each section within a chapter, with a topic paragraph.

   The topic paragraph states the collection of ideas to be explained in subsequent paragraphs, and tells the reader why he should pay attention to the subsequent definitions, details, etc.

3. Always start each paragraph with a topic sentence.

   The topic sentence summarizes the point of the paragraph in one sentence. The remaining sentences merely elaborate on the topic sentence. There should be NO sentence in a paragraph that does NOT relate to the topic sentence.

4. Link the first sentence in a paragraph that is preceeded by another paragraph (not a section or chapter break) to the thought in the last sentence in the preceeding paragraph. The first sentence of the first paragraph of a section or chapter should somehow be linked to the thought in the preceeding section or chapter, respectively.

   This linking, sometimes called spiraling, provides transition between paragraph, makes it hard for the reader to stop reading, and thus makes the section or chapter read smoothly.

5. Write a clear, concise problem statement in the first section.

6. Avoid needless words.

7. Eliminate ambiguity.

8. Use strong verbs rather than weak verbs with adverbs.

Mechanical Rules

1. Always number figures and tables according to their first reference in the text.

2. Always place the figure (e.g., the \begin{figure}...\end{figure} environment) immediately after the end of the paragraph containing the first reference to the figure.

3. Define notation, mnemonics, and acronyms before using them.

   Also, do not locate the definition pages before its first use. Finally, avoid defining notation, mnemonics, or acronyms if there are used two or fewer times.

4. Use notation consistently. If i has domain 0<i<N on one page, do not change the domain of i to M<i<=2M on the next page.