These are Dr. Choueiry's Golden Rules for writting papers taken from http://csce.unl.edu/~choueiry/Advising/BeforeYouSubmitaReport.txt on 12/1/2006.
---
When writing a report or a thesis, get quickly to the point. Do not lose time making general statements about the state of science, technology, or world politics that are not DIRECTLY relevant to the subject matter. The shorter your document, the better. The reader really does not have the time for tangent discussions.
- - Focus on YOUR contribution. - Address related work ONLY as it affects your work DIRECTLY. - Keep background information as short as possible: your report
- is NOT a tutorial
============ GOLDEN RULES for writing and formatting
BEFORE YOU SUBMIT YOUR REPORT/PAPER/THESIS FOR PUBLICATION OR TO ME, PLEASE RUN CAREFULLY THROUGH THE CHECK LIST BELOW:
- Refer to the `components' of your document always in capital
- letters, as follows:
Chapter~\ref{chap:x},
Section~\ref{sec:x},
Figure~\ref{fig:x},
Equation~(\ref{eq:x}) (notice the parentheses!),
Table~\ref{tab:x}, etc.- Notice the use of the ~ sign between the keyword and the reference. It prevents the two from being split between two lines.
- NEVER have the titles of a section and subsection without texts
- between them.
- NEVER have a section with a unique subsection: rethink and
- restructure your text.
- Always include both genders: he/she, his/her, him/her, himself/herself.
- Use active and not passive form (e.g., "we have shown" and
- not "it is shown").
- Each sentence has a subject, verb and object (no place for poetry).
- Do not confuse the use of "that" and "which" (in American English).
- If you don't know the rule, please learn it from
[http://www.chicagomanualofstyle.org/CMS_FAQ/Whichvs.That/Whichvs.That01.html which versus that]
- The words "e.g." and "i.e." are Latin words and stand for "exempli
- gratia" (meaning for example) and "id est" (meaning that is). When used within parentheses (i.e., as I am using then in this statement), they must be followed with a comma. When used inside the sent, e.g. as used in this statement, they should NOT be following by a comma.
- When using "e.g." and giving several examples, make sure
- you include a comma between examples and an "and" before the last alternative (e.g., an apple, an orange, and a prune). Also, make sure that you do NOT include an "etc." because you are simply giving examples. Do not use: "e.g. an apple, an orange, and a prune, etc. This is wrong.
- Run a spell checker (M-x ispell-buffer)
- All captions are in \small and end with a full-stop.
- All figures/tables are referenced in the text, *before* they appear.
- Figure/table citation and the figure/table itself should be as close to each other as possible.
- All sentences end with a full-stop.
- NEVER separate a subject (no matter how long) and its verb by a comma.
- There is NEVER a space between a word and the following punctuation mark.
- There is ALWAYS a space between a word and the preceding punctuation mark.
- (A space must appears AFTER a punctuation mark and not BEFORE it).
- All words are correctly capitalized.
- All citations are correct and complete.
- All acronyms are properly defined. Example: backtrack (BT) search.
- forward checking (FC)....
- The first time a new term is used, it can be italicized for emphasis.
In LaTex use {\em term\/}.
- NEVER use bold face {\bf xxx} or underline \underline{} in the
- text. It is used in titles of sections, figures, and tables.
- All definitions are formally introduced.
- All Equations are numbered and centered.
- In your pseudo-code.
- All `commands' (while, if, repeat) are in bold (\bf). All functions are in small caps (\sc) All constants are in courier (\tt) All your variables are properly initialized/introduced Input/output properly defined.
- The 3-noun rule: Engineers have a bad tendency for using 4 or 5
- nouns, which is totally confusing. For instance, they can write:
- "The third world hunger ending campaign division"
- First, NEVER use more than 3 nouns in a sequence:
- "Division of ending-hunger campaign in the third world"
- (I know the latter is not particularly nice, but it is far better than the former.)
- "Division of ending-hunger campaign in the third world"
- Second, you need to add a hyphen between the two nouns whose
- meanings are the closest. For example, write: third-world hunger, problem-solving skills, interactive problem-solvers, etc. Check the Chicago Manual of Style for more details about the rule.
- Never use informal English. Never use the form: "So, we decided,
- etc." Instead, you may use the form "Consequently," "As a result," "Thus," "Hence," etc.
- Never use "it's" in technical writing. Use either "it is" or "its,"
- whichever applies. If you stick to this rule, it will be harder to make the mistake.
- Replace all
- "can't" with "cannot" "don't" with "do not" "didn't" with "did not"
- Never use the pattern "This shows..." Be specific what "this" means.
- Write "This fact/experiment/behavior/ shows..."
- When reading what you wrote, systematically strike every occurrence
- of the word "very."
- Some words in English derive from Latin and their plural forms can
- be challenging. Here are some examples (singular/plural):
- criterion/criteria, datum/data (datum is seldom used and data is a word in plural), focus/foci (altough focuses is accepted today), formula/formulae (although formulas is sometimes used today), phenomenon/phenomena, optimum/optima, maximum/maxima, medium/media, minimum/minima, scenario/scenarii (although scenarios is pretty well accepted today), etc.
- Do not include bibliographic references in the title of a chapter,
- section, sub-section, or sub-sub-section.
- Some reviewers require that references be listed in a uniform way:
- either you include the first names of all authors, or you put only the initials. Choose one option or the other and stick to it. When using the initials do not leave a space between the initials of the first and middle names: Joel M. Gompert is abbreviated J.M. Gompert.
- Correct use of the expression "we denote":
- (1) We denote the set of elements by X (2) We denote the set of elements as X
_ [adapted] From: Joel M Gompert <jgompert@cse.unl.edu> To identify where you used a passive form (and replace is with an equivalent active form, do a search for the following words: Unless I'm forgetting something, searching for these words will locate all uses of the passive form. If the word is followed by a predicate (i.e., a noun or adjective) then the form used is active. If the word is used in the continuous sense (i.e., it is followed by a verb with -ing, e.g. "is running"), then it is active. Otherwise, it is probably a passive form. To detect the occurrence of the pattern "This shows..." I find that it is helpful to search for every occurrence of the word "this" and see if it is followed by a noun (e.g., "this graph", "this algorithm", and "this worst case"). Otherwise, a noun probably needs to be added or the sentence reworked. Note that a similar rule may be created about the word "that" (keeping in mind that "that" has more meanings than "this"). www.JoelGompert.com
HOW TO FORMAT PSEUDO CODE
Make sure you: - specify the input and output parameters - declare and initialize all the variables used. - do not declare or initialize variables you do *not* use.
Typesetting, write the name of - functions and procedures in small caps font {\sc Function-Name} - data structures in emphasized font {\em data-structure-name} - constants in courier font {\tt Constant-Name}
- For making an assignment, use the form "a <-- b" ($a \leftarrow b$) - For making a test, use the form "a = b" - For control constructs, limit yourself to the minimum: while,
- repeat, for, etc.. Do not use when, unless (they are Lisp'y and not conventional).
- Use an algorithm style package, avoid formatting yourself.
- Make sure you provide a worst-case complexity estimate in the text.
HOW TO FORMAT YOUR BIBLIOGRAPHY ITEMS
- In bibliography, never mix the use of
- "initials and last name" and "first name and last name".
- Choose one style and stick to it.
- In a report or in a thesis, use the named style for the
- bibliography.
- In a paper, follow the publisher's requirements. That is, use the
- plain style if requested by the publisher.
- In the named style, use \shortcite{} and \cite{} as follows:
Clinton and Kerry~\shortcite{Clinton:2004} set the rules for democratic elections for.... The rules for democratic elections for ..... are set
in~\cite{Clinton:2004}.
HOW TO FORMAT CHARTS
- The labels of the axes of a chart should be centered (vertically and
- horizontally) and in bold face.
- Do not use different colors to draw data in charts, but use
- different line/rectangle patterns. Make sure they print well on black and grey and are clearly distinguishable.
- Make sure lines are thick enough and do not fade too easily with
- repeated photocopying of the document.
HOW TO INCLUDE FIGURES
- Use the following figure template for one figure:
- \begin{figure}[ht]
\centerline{\psfig{file=<file-directory/file-name>.eps,height=xcm}} \caption{\small Some text.} \label{fig:xx} \end{figure}
- Use the following template for two or more figures
- WITH DIFFERENT CAPTIONS: \begin{figure}[ht] \begin{minipage}[t]{.45\textwidth}
\centerline{\psfig{file=<file-directory/file-name>.eps,height=xcm}} \caption{\small Some text.} \label{fig:xx} \end{minipage} \hfil \begin{minipage}[t]{.45\textwidth} \centerline{\psfig{file=<file-directory/file-name>.eps,height=xcm}} \caption{\small Some text.} \label{fig:xx} \end{minipage} \end{figure}
- Use the following template for two or more figures
- WITH THE SAME CAPTION: \begin{figure}[ht] \begin{center} \begin{tabular}{ccc}
\psfig{file=<file-directory/file1>.eps,height=5cm} & \psfig{file=<file-directory/file2>.eps,height=5cm} & \psfig{file=<file-directory/file3>.eps,height=5cm} & \end{tabular} \end{center} \caption{\small Left: xxx. Center: xxx. Right: xxx.} \label{fig:xx} \end{figure}
HOW TO INCLUDE TABLES
- Use the following figure template for one table:
- \begin{table}[ht] \begin{center} \caption{\small Some text.} \label{tab:xx} \begin{tabular}{ccccccc}\hline
- ..... \end{tabular} \end{center} \end{table}
Please bear with, and respect, these "pet peeves" of mine in order to increase the efficiency of our collaboration.
Your committed advisor,
-Berthe Y. Choueiry choueiry@cse.unl.edu