REPORT WRITING

 

 

 

 

 

60% of a Professional Programmer's Task involves:

That is, a lot of Technical Writing!

 

 

 


 

 

APPROACHES TO WRITING

Everyone has their own set of guidelines

Suggestions:

 

 

 


 

 

DISCIPLINARY CONTENT

DISCIPLINARY KNOWLEDGE
know what you are talking about
know your audience

RESPECT COMMUNITY CONVENTIONS
be aware of domain methods
talk the audience's "language"
 

 

 


 

 

USE PLAIN ENGLISH

 

 

 


 

 

PRODUCT BASED WRITING

FOCUSSES ON GRAMMAR AND STYLE
follows "classic" models

Ogden Nash -- Limericks
MAD LIBS
"... in the style of ..."
Grading Sheets

GUIDEBOOKS ON STYLE
The Elements of Style by William Strunk, Jr.
Chicago Book of Style
Author's Style Manual
Journal Instructions to Authors:

 

 

 


 

 

PROCESS BASED WRITING

SOFTWARE DEVELOPMENT WATERFALL MODEL

 

 


 

 

 

REQUIREMENTS

 

 

 


 

 

THINK ABOUT THIS

If your customer (manager, teacher, editor) asks some specific questions or sets some specific goals, then it is incumbent on you to
IDENTIFY and ANSWER THE QUESTIONS
This may well provide an outline to the report/paper

 

 

 


 

 

SPECIFICATIONS

FROM THE PRODUCT PLAN


FROM THE PROCESS PLAN


 

 

 


 

 

The Purpose of the Journal

 
To retrospectively review the activities of the writing project and to identify places where improvements can be made
 
 

 

 


 

 

DESIGN

 

 

 


 

 

IMPLEMENTATION

 

 

 


 

 

TESTING

 

 

 


 

 

MAINTENANCE

(When you plan to re-use a piece)

 

 

 


 

 

BASIC OUTLINE

 

 

 


 

 

INTRODUCTION

Outline 

 

 


 

 

BACKGROUND

Outline 

 

 


 

 

CONCLUSIONS

Outline 

 

 


 

 

SUMMARY

Outline 

 

 


 

 

APPENDICES

Outline


 

 

 

 

 

CONCLUSION

If you cannot -- in the long run --
tell everyone what you have been doing
THEN your doing has been worthless
-- Edwin Schrodinger, The Business of Biotechnology


This set of notes is planned to be capable of being covered in a 50 minute class, and thus miss out some things that others may think to be essential. My apologies!


Last updated 99/01/22
© J.A.N. Lee, 1994,1997, 1999.