Chapter 1-6

Writing for Computer Science, by Justin Zobel

Introduction

---

kinds of publication

• book
• thesis
• journal article
• conference or workshop proceedings
• complete paper
• extended abstract
• technical report

A paper should be an objective addition to scientific knowledge, not a description of the path you took to the result.

Style is not about correct use of grammar, but about how well you communicate with likely reader.

Basic aims of science writing

• To be clear
• unambiguous
• correct
• interesting (not dull)
• direct

Good style

---

Economy: Text should be taut

You should consider what I write that lead the reader astray.

Don't omit words that make the writing easier to understand.

Bit-stream interpretation require external description of stored structures. Stored descriptions are encoded, not external.

Interpretation of bit-streams requires external information such as descriptions. Such descriptions are themselves data, and if stored with the bit-stream become part of it, so that further external information is required.

Tone: Science writing should be objective and accurate.

literature style

• nuance (의미, 소리, 색상, 감정상의) 미묘한 차이, 뉘앙스
• ambiguity
• metaphor: A figure of speech in which a word or phrase is applied to an object or action to which it is not literally applicable
• sensuality

these are inappropriate for technical work.

the primary objective is to inform, not entertain.

common fault in scientific writing.

use of turgid (congested)

convoluted language

Good tone

direct, simple style but not dull (직접적이고 간결하지만, 지루하지는 않은)

Aim for austerity, not pomposity (겸손하게, 호헌 장담 하지말라)

Avoid buzzword(유행어), cliche(상투적인말), slang.

Omit any unnecessary material.

Be specific, not vague or abstract.

Don't be to overqualify

The upper hand(우세, 우위): Some author seem to have a superiority complex a need to prove that they know more or are smarter than their readers. 

과학자들이 읽지 않는 이상한 문장을 넣는다. 철학적인

불필요하게 어려운 수식을 넣는다.

제대로된 설명없이 무심한 말을 한다.

잘알려지지도 않거나, 접근하기 어려운 참고문헌을 인용 한다.

This kind of showing of, of attempting to gain the upper hand over the reader, is snobbish and tiresome.

Since the intention is to make statements the reader won't understand, the only information conveyed is an impression of the author's ego.

Write for an ordinary reader, as your equal.

Obfuscation

---

실제 주장없이 단순히 한 일을 쓰는 방식.

Experiments, with the improved version of the algorithm as we have described, are the step that confirms our speculation that performance would improve. the previous version of the algorithm is rather slow on our test data and improvements lead to better performance.

첫번째 문장이 너무 단조롭다. "experiments .. are the step that confirms our speculation"

위 문장은 사실이다. 하지만 not informative 하다. 

또 다른 문장으로 "improvements lead to better performance" (tautologous, 반복) 이다.

결정적으로, 실험을 수행한것은 알겠는데, 직접적인 주장이 없다는게 문제이다.

vague statements (희미한 문장)

이것은 항상 상세한 문장 보다 선호되어서 사용 된다.

Amelioration can lead to large savings.

Amelioration led to savings of 12%-33% in our experiments.

exaggeration (과장)

omission of relevant information (생략)

Bold statements of conclusions based on flimsy evidence.

The status of the system is such that a number of components are now able to be operated.

Several of the system's components are working.

In respect to the relative costs, the features of memory mean that with regard to system today disk has greater associated expense for the elapsed time requirements of tasks involving access to stored data.

Memory can be accessed more quickly than disk.

Analogies (유추)

---

사람마다 느끼는게 다르게 된다.

Writing a program is like building a model with connector blocks.

connector block이 무엇인지 모른다.

programmer가 아니라면, programming인것을 알 수 있나>

Contrasting look-ahead graph traversal with standard approaches, look-ahead uses a brid's eye view of the local neighbourhood to avoid dead ends, but at significant cost: it is necessary to feed the brid and wait for it to return aftereach observation 

Beware of analogies with situations that may be unfamiliar to the reader.

Straw men

---

반박할 여지가 없는 가설을 말한다. 즉 저자가 오로지 비평의 목적을 위해서 사용하는 내용을 말한다.

데이터베이스는 인덱스를 요구하지 않는다. 이런 말도안되는걸 쓰고 뒤에서 비평하는것은 주장을 뒷 받침 하는것에 전혀 도움이 되지 않는다.

  다른 사례는 새로 제안하는 방법을 좋게 만들기 위해서 가능하지도 않는 안좋은 방법을 만들어내서 비교하는 경우 이다. 이런 경우, 독자는 자신을 마치 이런 말도안되는 것을 사실인 만양 느끼게 한다고 생각하기에 매우 불쾌함을 느끼게 된다.

Query language have changed over the years. For the first database systems these were no query language and records were retrieved with programs. Before then data was kept in filing cabinets and indexes were printed on paper. Records were retrieved by getting them from the cabinets and queries were verbal, which led to many mistakes being mad. Such mistakes are impossible with new query language like QIL.

이것을 더 어렵게 만드는것은, 정말 오래된 연구와 비교하는 방법이다. 이러한 방법은 최근에 많이 바꼇을 수 있기 때문에 적합 하지 않다.

rhetoric(수사법)을 이용하는 방법, 즉 정확한 이유없이 그럴듯한 표현으로 대충 주장을 뒷받침 하려는 것이다. 

We did not investigate partial interpretation because it is known to be ineffective.

어떤 내가 하지 않는 것을 주장하기 위해서는 반드시 인용해야 한다. 근거없는 주장을 인용을 통해서 뒷받침하지 않고, 그럴듯하게 꾸며서 마치 accepted knowledge인 것 처럼 만드는 것을 말한다.

Most users prefer the graphical style of interface.

We believe that most users prefer the graphical style of interface.

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.

Reference and Citation

---

self-reference는 그것으로 하여금, 연구에 깊이가 있어보이고, 족보가 있어보이므로, 많이들 사용 하는 방법이다.

하지만, 의미없는 자기인용은 독자로 하여금 큰 실망을 주게되므로, 하지말아야한다.

인용을 해서 표현할때는 정확하고 충분하게 그 이야기를 설명해줄필요가 있다. 어떤 저자는 그 참고문헌을 못볼 수도 있기 때문이다.

그리고 선행 연구자에대해서 충분히 존경심을 담아서 그것을 논해야한다. 너무 아첨할 필요도 없고, 너무 비하해서도 안된다.

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.

인용시는 무명 모다는 정보를 뭐라도 주는것이 좋다.

Other work [16] has used an approach in which...

Marsden [16] has used an approach in which ...

Other work (marsden 1991) ahs used an approach in which ...

불필요한 레퍼런스에대한 논의는 피해라.

Several authors have considered the problem of unbounded delay. We cite, for example, Hong and Lu (1991) and Wesley (1987).

Several authors have considered the problem of unbounded delay.

Quotation (인용)

---

Acknowledgements

In the acknowledgements of a scientific paper you should thank everyone who made a contribution, whether advice, proofreading, or whatever: include research students, research assistants, technical support, and colleagues.

다음에 두가지 기본적인 폼을 보이겠다.

I am grateful to Dale Washman, Kim Micale, and Dong Wen, I thank the Foundation for Science and Development for financial support.

너무 감사의 글을 광범위 하게 하지말아라.

Kim, Dong이 증명에 도움을 줬다면, 왜 그들을 저자 리스트에 넣지 않았는지 의문이 생기게 된다. 적당한 수준에서 끝내야 한다. 아래와 같이정확히 어떤 부분에서 지식적으로 기여를 해줬는지를 적는다. 너무 크면 안된다.

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 thank the Foundation for Science and Development for a year of financial support.

I am grateful to Dale Washman and Kim Micale for our fruitful discussions, and to Dong Wen for programming assistance. I thank the Foundation for science and Development for financial support.

다음과 같은 표현은 쓰지말자.

"I would like to thank"

"I wish to thank"

이것은 약간, I wish to thank ... but for some reason I am unable to do so. 의 nuance가 있다.

그냥 간단하게

"I am grateful to"

"I thank"

"Thanks to"

이렇게 쓰면 된다.

 

Grammar

---

이 책에서는 문법은 다루지 않는다. 좋은 글이란 문법이 문제가 되지 않는다.

몇몇 사람들은 다른 사람들의 글을 비판하기 위해서 전통적인 grammar rule을 사용하게 된다. 

하지만 이것은 clarity나 meaning을 희생하면서 가지 할 것은 아니다.

그렇지만, 과도한 문법 오류는 독자를 짜증나게하므로 매우 주의 해야한다.

문법을 지키는것은 기본이며, 좋은 글이 되기위한 충분 조건은 아니다.

Beauty

---

prose(산문)에나 어울리는 것이다.

무조건 simplicity 하고 clarity 하게 작성해라.

crystalline, transparent, and good rhythm들 까지 고려하면 좋지만, 필요 없다.