Skip to content

Instantly share code, notes, and snippets.

@miquelramirez

miquelramirez/technical_writing.md

Last active January 17, 2019 04:18
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save miquelramirez/92fa38c8bcf8e39f599308357bf16c5f to your computer and use it in GitHub Desktop.
Save miquelramirez/92fa38c8bcf8e39f599308357bf16c5f to your computer and use it in GitHub Desktop.
Download ZIP
Useful Resources for Technical Writing
Raw
technical_writing.md

COMMON ERRORS IN TECHNICAL WRITING

http://web.ece.ucdavis.edu/~jowens/commonerrors.html

How not to write an abstract

https://www.lightbluetouchpaper.org/2007/03/14/how-not-to-write-an-abstract/

we have certainly not written the abstract last - because the paper hasn't been written yet! - but other than that somewhat loopy confusion of cause and effect, there's good advice in there.

The Science of Scientific Writing

http://psychology.yale.edu/sites/default/files/gopenswan_onsciencewriting.pdf

very old paper, still cracks me up like the first time I read it, and still I fall into the mistakes the authors outline

The Elements of Style, by Oliver Strunk

Strunk's master piece - a book now I then I revisit Prof. Strunk aphorisms'

How To Write A Lot, by Paul Sylvia

I remember this one quite fondly, even if the discipline covered (Psychology) is somewhat removed from what we do. Of specific interest is Chapter 6, drawing the applicable analogies to the kind of methods and templates we use.

Note that (technical) writing is a skill that we never end learning - every paper you produce teaches you new stuff about writing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment