1. Writing for Computer Science 3. Style specifics 2008. 04. 04 Cho, Ho-Gi GNU OSLab.

2. GNU OSLabWriting for Computer Science 2 Contents  Titles and headings  The opening paragraphs  Variation  Paragraphing  Ambiguity  Sentence structure  Tense  Repetition and parallelism  Emphasis  Definitions  Choice of words  Qualifiers  Misused words  Spelling conventions  Jargon  Cliché` and idiom  Foreign words  Overuse of words  Padding  Plurals  Abbreviations  Acronyms  Sexism

3. GNU OSLabWriting for Computer Science 3  Titles of papers and sections should be concise, informative and accurately describe the content X A New Signature File Scheme Based on Multiple-Block Descriptor Files for Indexing Very Large Data Bases O Signature File Indexes Based on Multiple-Block Descriptor Files  Don’t make the title so short that it is contentless. O Limited-Memory Huffman Coding for databases of Textual and Numeric Data X Huffman Coding for databases  Accuracy is more important than catchiness. Strong Modes Can Change the World! Titles and headings

4. GNU OSLabWriting for Computer Science 4  do not have to be complete sentences X Duplication of Data Leads to Reduction in Network Traffic O Duplicating Data to Reduce Network Traffic  Section headings should reflect the paper’s structure 1Lists and Trees ← major section (number) Lists← minor section (not number) Definition 1.1 ….← numbered by the major section number Trees← minor section Definition 1.2 ….

5. GNU OSLabWriting for Computer Science 5  can set the reader’s attitude to the whole paper XTrees, especially binary trees, are often applied-indeed indiscriminately applied-to management of dictionaries. ODictionaries are often managed by a data structure such as a tree, but trees are not always the best choice for this application  The first paragraphs must be intelligible to any likely reader  “This paper concerns” or “In this paper” means that results are going to be stated out of context XIn this paper we describe a new programming language with matrix manipulation operators. OMost 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. The Opening paragraphs

6. GNU OSLabWriting for Computer Science 6  The opening sentences should clearly indicate the topic XUnderutilization of main memory impairs the performance of operating systems. OOperating systems are traditionally designed to use the least possible amount of main memory, but such design impairs their performance.  distinguish description of existing knowledge from the description of the paper’s contribution XMany user interfaces are confusing and poorly arranged. Interfaces are superior if developed according to rigorous principles. OMany user interfaces are confusing and poorly arranged. We demonstrate that interfaces are superior if developed according to rigorous principles.

7. GNU OSLabWriting for Computer Science 7 Variation  Diversity 1) is a useful device for keeping the reader’s attention XThe system of rational numbers is incomplete./This was discovered 2000 years ago by the Greeks./The problem arises in squares with sides of unit length./The length of the diagonals of these squares is irrational./This discovery was a serious blow to the Greek mathematicians. OThe Greeks discovered 2000 years ago that the system of rational numbers is incomplete./The problem is that some quantities, such as the length of the diagonal of a square with unit sides, are irrational. /This discovery was a serious blow to the Greek mathematicians. 1)Organization, structure, length of sentences and paragraphs, and choice of words

8. GNU OSLabWriting for Computer Science 8 Paragraphing  A paragraph consists of discussion on a single topic or issue. 1)  Long paragraphs can indicate several lines, but can be broken, break it; so don’t divide  Link paragraphs by re-use of key words or phrases if a paragraph discusses a fast sorting algorithm, the next paragraph should not begin “This algorithm” but rather “The fast sorting algorithm” 1)first sentence: outline or the argument, rest sentence: amplification or example, last sentence has higher impact than those in the body

9. GNU OSLabWriting for Computer Science 9  The use of formatted lists as an occasional alternative to paragraphs is common They highlight each main point clearly. The context remains obvious, whereas, in a long list of points made in a paragraph, it is hard to tell whether the later points are part of the original issue or belong to some subsequent discussion. An individual point can be considered in detail without confusing the main thread of narrative. They are easy to refer to

10. GNU OSLabWriting for Computer Science 10  Check carefully for ambiguity hard to detect in your own text because you know what is intended XThe compiler did not accept the program because it contained errors. OThe program did not compile because it contained errors.  Ensure that pronouns such as “it”, “this”, and “they” have a clear referent XThe next stage was the test of the complete system, but it failed.  Another problem with “it” is that it is overused. XThe machine crashed and it was necessary to reboot it. OThe machine crashed and a reboot was necessary. Ambiguity

11. GNU OSLabWriting for Computer Science 11  Premature pronouns also lead to difficulties. XWhen it was first developed, recursive compilation was impractically slow and required to much memory. OWhen recursive compilation was first developed, it was impractically slow and required too much memory.

12. GNU OSLabWriting for Computer Science 12 Sentence structure  Sentence should have simple structure don’t say too much all at once  to avoid nested sentences XIn the first stage, the backtracking tokenizer with a two-element retry buffer, error, including illegal adjacencies as well as unrecognized tokens, are stored on an error stack for collation into a complete report.  really is required, then put it in a separate sentence OThe first stage is the backtracking tokenizer with a two-element retry buffer. In this stage possible errors include illegal adjacencies as well as unrecognized tokens; when detected, error are stored on a stack for collation into a complete report.

13. GNU OSLabWriting for Computer Science 13  Watch out for fractured “if” expressions XIf the machine is lightly loaded, then speed is acceptable whenever the data is on local disks. OIf the machine is lightly loaded and data is on local disks, then speed is acceptable. OSpeed is acceptable when the machine is lightly loaded and data is on local disks.  Sometimes longer sentences can be divided by simply replacing an “and” or “,” If there is no particular reason to join two sentences, keep them separate.

14. GNU OSLabWriting for Computer Science 14  Double negatives are difficult to parse and are ambiguous XThere do not seem to be any reasons not to adopt the new approach. OThe new approach is at least as good as the old and should be adopted.  Organize your sentences so that they can be parsed without too much backtracking. Ambiguous words or phraseology, even if clear in the context of a whole sentence, can slow the reader down  Know your limits. Experienced writers can construct good sentences