Skip to content

Writing style guidance

Jump to bottom
Laura Cowen edited this page Dec 20, 2017 · 4 revisions

(Work in progress - needs nicer formatting too) For each piece of guidance, give:

  • A statement of the guidance.

  • The reason(s) why (so that authors can learn and use their judgement about it).

  • One or two examples from the published guides of how to do it right.

  • One or two examples of how not to do it.

Tense

Use the present tense almost all the time. Only use the future tense when something is literally in the future (describing the functioning of some code when it’s compiled doesn’t count as future).

Example:

Clone this wiki locally