Paper Writing Style. Writing Style Economy Tone Examples Balance Voice.

Paper Writing Style

Writing Style

• Economy• Tone• Examples• Balance• Voice

Writing Style

• Obfuscation• Analogies• Straw men• Reference and citation• Quotation• Acknowledgements• Beauty

Writing Style - Economy

• Text should be taut– Aim to delete superfluous words– simplify sentence structure– establish a logical flow

• Convey information without unnecessary dressing

Writing Style - Tone

• Science writing should be objective and accurate– Have idea per sentence or paragraph and one topic per

section.– Have a simple logical organization.– Use short words.– Use short sentences with simple structure.– Keep paragraphs short.– Avoid buzzwords ， clichés, and slang.– Avoid excess, in length or style.– Omit any unnecessary material.

• X As each value is passed to the server, the "heart" of the system, it is checked to see whether it is in the appropriate range .

• √ Each value passed to the central server is checked to see whether it is in the appropriate range.

Writing Style - Examples

• Use an example whenever it adds clarification.• For example, such as, … “In a semi-static model, each symbol has an

associated probability representing its likelihood of occurrence. For example, if the symbols are characters in text, then a common character such as "e" might have an associated probability of 12%.”

Writing Style - Balance

• Within a paper, each topic should be discussed to a similar depth– An algorithm that is only sketched does not merit

twenty graphs and tables– an algorithm that it is described in detail needs a

substantial analysis or other justification.• When a paper must be kept within a length

limit, some compromise is required.

Writing Style - Voice

• Avoid excessive use of indirect statements (or passive voice)• particularly descriptions of actions that don't indicate who

or what performs them.ⅹ The following theorem can now be proved .√ We can now prove the following theorem.

• Avoid artificial use of verbs like "perform”,"utilize“, "achieved", "carried out", "conducted","done", "occurred", and "effected"

X Local packet transmission was performed to test error rates .

√ Error rates were tested by local packet transmission.

Writing Style - Straw men

• A straw man is an indefensible hypothesis that an author describes for the sole purpose of criticizing it.

X Another possibility would be a disk-based method, but this approach is unlikely to be successful.

√ Another possibility would be a disk-based method, but our experience suggests that this approach is unlikely to be successful

Writing Style – Reference and Citation

• Explain the relationship of your new work to existing work

X Robinson's theory suggests that a cycle of handshaking can be eliminated, but he did not perform experiments to confirm his results [22] .

√ Robinson's theory suggests that a cycle of handshaking can be eliminated [22], but as yet there is no experimental confirmation.

Writing Style – Quotations• Quotations are text from another source,

usually included in a paper to support an argument.

• X Hamad and Quinn (1990) show that "similarity [sic] is functionally equivalent to identity"; note that similarity in this context means homology only, not the more general meaning used in this paper.

• √ Hamad and Quinn (1990) show that homology "is functionally equivalent to identity".

Writing Style – Acknowledgements

• two common forms of acknowledgement– simply list the people who have helped with the

paper .– to explain each person's contribution

• X I am grateful to Dale Washman for discussing aspects of the proof of Proposition 4.1 , to Kim Micale for identifying some technical errors in Theorem 3, and to Dong Wen for helping with use of the debugging tools.

• √ I am grateful to Dale Washman and Kim Micale for our fruitful discussions, and to Dong Wen for programming assistance.

Style Specific

• Titles and headings Titles of papers and sections should be

concise and informative• The opening paragraphs The opening paragraphs can set the reader's

attitude to the whole paper

• X This paper does not describe a general algorithm for transactions.

• √ General-purpose Transaction algorithms guarantee freedom from deadlock but can be inefficient. In this paper we describe a new transaction algorithm that is particularly efficient for a special case, the class of linear queries.

Style Specific

• Starting an abstract or introduction with ‘'This paper concerns" or "In this paper" often means that results are going to be stated out of context.

X In this paper we describe a new programming language with matrix manipulation operators .

√ Most numerical computation is dedicated to manipulation of matrices, but matrix operations are difficult to implement efficiently in current high-level programming languages. In this paper we describe a new programming language with matrix manipulation operators.

Style Specific – Sentence Structure

• Sentences should have simple structure, which usually means that they will be no more than a line or two.

X In the first stage, the backtracking tokenizer with a two-element retry buffer, errors, including illegal adjacencies as well as unrecognized tokens, are stored on an error stack for collation into a complete report.

√ The first stage is the backtracking tokenizer with a two-element retry buffer. In this stage possible errors inc1ude illegal adjacencies as well as unrecognized tokens; when detected, errors are stored on a stack for collation into a complete report.

Style Specific – Tense

• In science writing, most text is in past or present tense.

• Present tense is used for eternal truths.• Past tense is used for describing work and outcomes.• Either past or present tense can be used for

discussion of references. Present tense is preferable but past tense can be forced by context.

• Other than in conclusions, future tense is rarely used in science writing.

Style Specific – Repetition and parallelism

• X The performance gains are the result of tuning the low-level code used for data access and improved interface design .

• √ The performance gains are the result of tuning the low-level code used for data access and of improved interface design.

• √ The performance gains are the result of improved interface design and of tuning the low-level code used for data access.

Style Specific – Emphasis

• X A static model is appropriate because each item is written once and read often.

• √ A static model is appropriate because each item is only written once but IS read often

Style Specific – Choice of words

• Abstract, vague, or broad terms have different meanings for different readers and lead to confusion.

• X The analysis derives information about programs

• √The analysis estimates the resource costs of programs.

Style Specific – Choice of words

• "important", "intelligent",• "method", "paradigm", "performance", and

"semantic". "Difficult”

Style Specific -- Misused words

• Which, that, the. – Many writers use "which" when they mean "that‘.– Use "that" in reference to "which“– use "which" only when it cannot be replaced by

"that".

X There is one method which is acceptable .√ There is one method that is acceptable .√ There are three options, of which only one is

tractable.

Style Specific -- Misused words

• Less, fewer. – Use "less" for continuous quantities ("it used less

space") and "fewer" for discrete quantities ("there were fewer errors").

• Alternate, alternative, choice.– The word "alternate" means other or switch

between, whereas an "alternative" is something that can be chosen. If there is but one alternative, there is no choice; "alternative" and "choice" are not synonyms.

Style Specific -- Misused words

• Assume, presume. – "Assume" means for now ， take as being true,

while "presume“ means take for granted. A fact is assumed as the basis of an argument, an event is presumed to have occurred.

• May, might, can. – Many writers use "may" or "might" when they

mean "can".– Use "may" to indicate personal choice, – and "can" to indicate capability .

Style Specific -- Abbreviations

• It is almost always desirable to expand these abbreviations

• X Methods available are random probing, extrapolation, etc .

• √ Methods available include random probing and extrapolation

• √ Methods such as random probing and extrapolation can be used.

Style Specific – Qualifiers

• Don't pile qualifiers on top of one another. Within a sentence, use at most one qualifier such as "might", "may", "perhaps", "possibly", "likely", "likelihood’ or "could".

• X We are planning to consider possible options for extending our results .

• √We are considering how to extend our results.

Punctuation

• Fonts and formatting• Most computing or mathematical writing uses

three fonts (plain, italic, and bold) or four

Punctuation

• Fonts and formatting• Most computing or mathematical writing uses

three fonts (plain,italic, and bold) or four

Punctuation -- Stops

• X The process required less than a second (except when the machine was heavily loaded, the network was saturated ， etc.).

• √The process required less than a second (unless, for example, the machine was heavily loaded or the network was saturated).

Punctuation -- Commas

• X The process may be waiting for a signal, or even if processing input, may be delayed by network interrupts .

• √ The process may be waiting for a signal, or, even if processing input, may be delayed by network interrupts.

Punctuation -- Colons and semicolons

• √ There are three phases: accumulation of distinct symbols, construction of the tree, and the compression itself.

• √ In theory the algorithm would be more efficient with an array; but in practice a tree is preferable.

Punctuation -- Apostrophes

• Singular possessives such as “the student's algorithm“ require an apostrophe and an "s".

• Plural possessives such as "students' passwords" require an apostrophe but no "s".

• Pronoun possessives such as "its" (as in "its speed") and "hers" do not require an apostrophe.

• Contractions such as "it’s(as in "it is blue") and "can’t require an apostrophe;

• but note that contractions should be avoided in technical writing.

Punctuation -- Quotation

• X One of the reserved words in C is "for."• √ One of the reserved words in C is "for".• √ Crosley [2000] argues that "open sets are of

insufficient power", but Davies [2002] disagrees: ''If a concept is interesting, open sets can express it."

Punctuation -- Exclamations

• Avoid exclamation marks! Never use more than one!!

• X Performance deteriorated after addition of resources!

• √ Remarkably, performance deteriorated after addition of resources.

Punctuation -- Parentheses

• X Most quantities are small (but there are exceptions.)

• √ Most quantities are small (but there are exceptions).

• X (Note that outlying points have been omitted) .

• √ (Note that outlying points have been omitted.)

Punctuation -- Citations

• X In [2] such cases are shown to be rare.• X In (Wilson 1984) such cases are shown to be rare.• √ Such cases have been shown to be rare [2].• √ Such cases have been shown to be rare (Wilson

1984).• √ Wilson [2] has shown that such cases are rare.• √ Wilson has shown that such cases are rare [2].• √ Wilson (1984) has shown that such cases are rare.