Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Scribd
Upload
34 views

Technical Writing: Accuracy Brevity Clarity

Uploaded by

Ahmed Essam Abd Rabou
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
34 views

Technical Writing: Accuracy Brevity Clarity

Uploaded by

Ahmed Essam Abd Rabou
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

TECHNICAL WRITING T.

HEGAZY

ABC of Technical Writing : 


Accuracy Brevity Clarity

- Correct in Content; - Not inflated; - Clear structure of


- No typographical errors in - Use abbreviated but precise sentences and paragraphs;
tables, figures or calculations; words; - Use clear words; invest in
- Use spelling and grammer - Use a Thesaurus; a good dictionary;
checkers. - Keep revising every word and - Ambiguous structure
expression you use; suggests that the writer
- Have others review your writing. doesn’t understand the
subject.
Writing in Style:
- No WE, US, I, or OUR;
- Choose clear words;
- Use plain English;
- Be precise;
- Avoid fancy jargon; Two Imprtant rules for reviewing
- Maintain focus; your written document:
- Attractive summary (abstract);
- Enticing objectives stated clearly and early enough; - Remove every word that is
ambiguous, can be miss-
- Avoid monotony;
interpreted, has double meanings,
- Link sentences and paragraphs (flowability); neutral, or does not add to the
- Avoid lengthy sentences; meaning;
- Avoid noun clusters;
- Avoid chains of relative clauses; - Check if Structure is logical, text is
- Choose active over passive verbs; flowable and every word has the
- Use concrete details; correct meaning you want.
- Make important ideas stand out;
- Subordinate minor ideas;
- Use contrasts;
- Use charts; figures; and tables to summarize information;
- Do not over-explain the obvious;
- Provide all inputs and outputs to allow reader to verify
the results;
- Use example applications to illustrate new concepts;
- State all assumptions and limitations;
- Must refer to quoted references; and
- Provide appropriate detail for the readers.
TECHNICALWRITING Checklist for Report Writing T. HEGAZY

Title:
† Accurately reflects the Topic; † Do they support some of your
† Interesting; assumptions?;
† Title page organized; † What need to be verified and enhanced;
† Names, dates, and places mentioned; † Can you compare with them later?;
† Font & style are good. † Font, style, and organization.

Summary/Abstract: Analysis (What did you do):


† One or two paragraphs; † Surveys, contacts, research?;
† Problem statement in first paragraph; † Analysis of results;
† Objectives and approach in second † How it can be used;
paragraph; † Font, style, and organization.
† Concise and clear;
† Font, style, and organization. Developments:
† Computer programming;
Table of Contents: † Statistical analysis;
† Organized with page numbers; † Results of your model and comparison
† Bold headings and dotted lines; with others (could be included in a
† Interesting titles; separete section for discussion);
† Font and size are good. † Concise and clear;
† Use illustrations, tables, and
Introduction: † Font, style, and organization.
† Importance of topic is elaborated;
† May include a subsection for scope and Conclusion and Recommendations:
objectives; † Is there significant findings;
† May include a subsection for the † New guidelines;
approach used; † New procedure/tool for analysis;
† Very clear objectives; † Better understanding of a problem and
† Very clear scope; the factors affecting it;
† May include details of related efforts † Example of use of new technology;
done by others (literature) if not many; † New decision-support;
† May have another interesting title than † Font, style, and organization.
Introduction;
† Text is flowable and easy to read; clear Acknowledgement:
distinction between what others did and † Short and organized.
the present work;
† Good style, short statements, and References:
accurate words; † Listed alphabetically;
† Use of illustrations, tables, comparisons, † All information, names, year, source,
etc; publisher, etc.
† Organization, font, and size; † Referred to correctly in text;
† Reference to others. † Font and size;

Related Efforts: (Literature Review) Appendices:


† scope of their work and relevance to † Organized andl isted alphabetically;
yours; † Includes all row data.
† Technology they used, procedure, data,
and results;
† Your constructive comments on their
work;
† What can be used as is;

You might also like