SMILE
mainImage

Unit 11: Technical writing - Organisationtechnical writing context diagramme

Organize the paper in “triangular” or “newspaper” style, not in “joke” or “novel” style. Newspapers start with the most important part, then fill in background later for readers who want more details.

A good joke or a mystery novel has a long windup to the final punchline. Put the punchline right up front and then slowly explain the joke. Too often, the reader never really finds out what the contribution of the paper is until the last page, the last table, and the last 5 minutes. They don’t care how you came to figure out the right answer.

technical writing why/how diagrammePut your contribution (what), before methods (why or how). Readers skim, so use the triangular style and open with your punchline.

Your Abstract
Most journals allow 100-150 words. The main function of the abstract is to communicate your contribtuion. Do not mention other literature in the abstract. It must be concrete. Say what you find, not what you look for.
Don’t write “data are analyzed, theorems are proved, discussion is made.”

Your Introduction
The introduction should start with what you do in this paper, the major contribution. Don’t just state your conclusion “My results show that the pecking-order theory is rejected.” Give the facts behind that result.
“In a regression of x on y, controlling for z, the coefficient is q.” The first sentence is the hardest.
“Two easily measured variables, size and book-to-market equity, combine to capture the cross-sectional variation in average stock returns associated with market B, size, leverage, book-to-market equity, and earnings-price ratios.”
Do not start with philosophy: “Financial economists have long wondered if markets are efficient.”
Do not start with “The finance literature has long been interested in x.” Start with your central contribution:
“Two easily measured variables, size and book-to-market equity, combine to capture the cross-sectional variation in average stock returns associated with market B, size, leverage, book-to-market equity, and earnings-price ratios.”
Three pages is a good upper limit for the introduction. Remember:

  • Abstract - no literature review
  • Introduction - first sentence
  • Start with contribution

Creative Commons License
Top tips for technical writing by Vince Ricci: CIEE, Joe Schall: Penn State University, Glynis Perkin: Loughborough University, edited by Marion Kelt: GCU is licensed under a Creative Commons Attribution 3.0 Unported License
Based on a work at http://www.slideshare.net/tokyovince/introduction-to-technical-writing-4305074 http://www.slideshare.net/engCETL/technical-report-writing-handout https://www.e-education.psu.edu/styleforstudents/c1_p15.html