Difference between revisions of "Resources"

From CompSciWiki
Jump to: navigation, search
(adding stuff)
(Reference's: trying to add book citation)
Line 25: Line 25:
 
== Reference's ==
 
== Reference's ==
 
[http://courses.cs.umanitoba.ca/index.asp?sec=3383 The Comp 3040 Website]
 
[http://courses.cs.umanitoba.ca/index.asp?sec=3383 The Comp 3040 Website]
 +
 +
{{ cite book
 +
  | last = Pfeiffer
 +
  | middle = Sanbord
 +
  | first = William
 +
  | coauthors = Jan Boogerd
 +
  | title = Technical Communication: A Practical Approach
 +
  | publisher = Pearson
 +
  | location = Toronot
 +
  | date = 2006
 +
  | isbn = 0-13-196293-0 }}

Revision as of 21:28, 2 April 2008

3040 Main Page

Chapter Introduction

Technical writers must follow a set of instructions and techniques to properly format their documents. First and most important consideration is the overall document layout. Documents should be designed in a way that would allow the reader to effectively reference key points and enhance the decision making process. The component layout should enhance or maintain reader's interest in you document. Proper use of definitions and descriptions ensures that your audience can follow along and are not facing ambiguities. Documents may be used directly by technical personnel to perform their job, therefore it is essential to provide detailed documentation for their operations. Finally, graphical content techniques can be employed to enhance the data presentation and analysis.


float

Resources

Common Writing Mistakes

Writing with Technology (Google Docs and Wikis)

Accessing On-line Journals

External Resources

Grammar

Common Writing Errors

Norton's Quick & Dirty Guide to Sentence Structure

Strunk's Elements of Style

Odd/Crazy Technical Writing

Why's (Poignant) Guide to Ruby

Other

Honesty Declaration

Reference's

The Comp 3040 Website

Pfeiffer, William;  Jan Boogerd () Technical Communication: A Practical Approach;  Pearson Toronot ISBN:0-13-196293-0