Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 1.76 KB

Writing.md

File metadata and controls

43 lines (36 loc) · 1.76 KB

Writing conventions

Spelling

  • American spelling
  • Some specific words with the chosen spelling
    • ad hoc
    • behavior
    • crowdsourcing is a single word, but crowd worker is two words
    • dataset
    • dialogue
    • judgment
    • labeling
    • learning-to-rank
    • modeling
    • normalization
    • use-case
    • semi-structured
    • state of the art (noun) vs. state-of-the-art (adj)
    • therefore

Capitalization and abbreviations

  • Section/subsection headings in Title Case: Like This and This.
  • Capitalization of certain words:
    • information retrieval, natural language processing
    • language modeling
    • intranet
    • web page, web site, web search, BUT, World Wide Web, Web 2.0
  • Chapter, section, table and figure references are always capitalized: Chapter X, Section X, Table X, Figure X.Y, BUT this chapter, this section.
  • Cross-references should be written in full when they stand at the beginning of a sentence (Chapter X, Section X, Figure X, etc.), otherwise abbreviated: Chap./Chaps., Sect./Sects., Fig./Figs., p./pp., Eq./Eqs.
  • a.k.a. (and not aka)

Punctuation and spacing

  • Use the serial comma; e.g., one, two, and three I want no ifs, ands, or buts
  • If a quote is followed by a dot or comma, the dot or comma should be put inside the quote
    • 'one example'. => 'one example.'
  • Footnotes should immediately follow the punctuation (no space between).
    • This is a sentence.\footnote{...}
  • Always put a comma after e.g. and i.e. E.g., In this case, e.g., ...
  • Never start a sentence with i.e., or e.g., but write out That is, and For example,.