basics of technical writing( report )

66
What are Reports?

Upload: api-3801998

Post on 14-Nov-2014

143 views

Category:

Documents


4 download

TRANSCRIPT

Page 1: Basics of Technical Writing( Report )

What are Reports?

Page 2: Basics of Technical Writing( Report )

“A business report is an orderly and

objective communication of

factual information that serves some

business purpose”.

Raymond Lesikar and John Pettit

Page 3: Basics of Technical Writing( Report )

Definition• Orderly- carefully prepared• Objective- unbiased• Communication- mostly writing• Factual information-emphasis on

events, records, data.• Purpose-example; solve a problem

and to present information.

Page 4: Basics of Technical Writing( Report )

“A report is a document in which a given problem is examined for the purpose of conveying information, reporting findings, putting

forward ideas and sometimes making recommendations”

The British Association of Commercial and Industrial Education

Page 5: Basics of Technical Writing( Report )

Types of Report1. Formality ( relationship of writer

and reader) and legality; • Formal • Informal 2. Function; • Informational • interpretative

Page 6: Basics of Technical Writing( Report )

3. Time interval; • Periodic• Special4. Physical factors/form;• Memorandum• Letter• Short• Long 5. Nature of subject;• Problem determining report• Fact finding report• Performance report • Technical report

Page 7: Basics of Technical Writing( Report )

Format • Title• Terms of reference1. By whom has the report been

requested/directed2. The precise area to be covered3. Intended outcome of the report4. Establishing the limits of the

report

Page 8: Basics of Technical Writing( Report )

Table of contents • List headings as they appear in

the body of the report, along with page numbers.

Page 9: Basics of Technical Writing( Report )

Format• Procedure (methods of investigation)1. Experiment2. Observation3. Survey4. Consultation5. Research• Findings• Recommendations (listed in conclusion)• signature

Page 10: Basics of Technical Writing( Report )

Basics of Technical WritingBasics of Technical WritingBasics of Technical WritingBasics of Technical WritingMain documentation priorities Main documentation priorities Use simple sentence structure (subject-verb-Use simple sentence structure (subject-verb-object)object)

this method terminates communicationthis method terminates communicationMinimize adjectives and adverbsMinimize adjectives and adverbsWrite predictably Write predictably Use graphics Use graphics

““A picture is worth 1,000 wordsA picture is worth 1,000 words””Apply seven ‘C’sApply seven ‘C’s

Page 11: Basics of Technical Writing( Report )

Problems that beginner writers have

Thinking that writing is easy Writing in EnglishUnderstanding how to get started Understanding how the software

worksOrganizing material

Page 12: Basics of Technical Writing( Report )

“Every journey begins with a step”

Page 13: Basics of Technical Writing( Report )

Write Clear Sentences

Page 14: Basics of Technical Writing( Report )

Write clear sentences Write active

sentences Write present tense Write positive

sentences Use short, familiar

words Write short

sentences Use lists

Page 15: Basics of Technical Writing( Report )

Active sentencesAre clearer; they tell the user who or

what does the action Passive; A mail message is sent to the main service.

Active; The handler sends a mail message to the main service

Are more conciseHelp you write from user’s view

Page 16: Basics of Technical Writing( Report )

Passive Vs ActiveActor is unknown

1. The file is opened by Ralph

Uses “to be”1. The file is printed 2. Lunch is eaten

Actor is unknown

• Ralph opens the file

Uses strong verbs• I print the file

• I eat lunch

Page 17: Basics of Technical Writing( Report )

Use passive sentences in certain situations

The actor is unknown or unimportant• To make any kind of connection to the internet, you must

determine how your computer is connected to the internet

The action or object is more important• To set up XYZ component, a sample application is provided

in the Samples directory of your program

Transitions need to be strengthened• To print the file. Press Print. The file is printed by your printer

Page 18: Basics of Technical Writing( Report )

Present tense• Helps users read the material

quickly• Tells users when to do something1. You will be able to select all display options2. Click the button. A submenu will appear

Correct:1. You can select all display options2. Click the button. A submenu appears

Acceptable use of future tense;Write down these steps. You will use these later.

Page 19: Basics of Technical Writing( Report )

Write positive sentences

• Do not turn off your computer without saving your work.

Correct;• Save you work, and then turn off

your computer.Acceptable use of negatives;Caution. Do not put your coffee up on the CD-ROM drive

Page 20: Basics of Technical Writing( Report )

Use short familial words

• Cigarette smoking is causally related to lung cancer in men; the magnitude of the effect of cigarette smoking far outweighs all other factors. The data for women, though less extensive, point in the same direction.

Correct• Cigarette smoking is a major cause of lung

cancer in men, and probably in women too.

Page 21: Basics of Technical Writing( Report )

Write short sentences• We hereby wish to let you know that

our company is pleased with the confidence you have reposed in us.

• We appreciate your confidence

Write a long sentence if separate sentence is too complex

Page 22: Basics of Technical Writing( Report )

Use lists

• Use bulleted lists for similar but unordered ideas

• Use numbered lists for a sequence of events or steps

Page 23: Basics of Technical Writing( Report )

The Seven ‘C’s of effective

communication1. Completeness2. Conciseness3. Consideration4. Concreteness5. Clarity6. Courtesy7. Correctness

Page 24: Basics of Technical Writing( Report )

Graphics • Tables• Fonts• Flowcharts and process charts• Pie chart• Line chart• Statistical Maps• Illustrations

Page 25: Basics of Technical Writing( Report )
Page 26: Basics of Technical Writing( Report )

Acknowledgment • ParaphraseLogan Wilson (201) criticized

academicians for being scientific in their approach to every area…

• Key phrase quotationLogan Wilson (201) characterizes as a

“curious paradox” what he sees as the failure of academics to be scientific….

Page 27: Basics of Technical Writing( Report )

Acknowledgment • Verbatim• Partial quotationAccording to Logan Wilson(201), “…

academics display a scientific attitude toward every universe except that which comprises their own profession”

• Extended quotation

Page 28: Basics of Technical Writing( Report )

Acknowledgement• Use MLA ( Modern Language

Association) style sheetMethods;1. Footnote methodCindy Burford, Aline Culberson, and Peter

Dykus, Writing for Results, 4th ed.,New York: Charles Storm Publishing Company, 1994, 17-18.

Page 29: Basics of Technical Writing( Report )

Methods of compiling data

• Library research• Sampling theory• Face to face interview

Page 30: Basics of Technical Writing( Report )

Library research• Encyclopedias• Government publications• International sources• Searching Databases• Internet

Page 31: Basics of Technical Writing( Report )

Sampling theory as a basis for surveying

• Random sampling• Systematic sampling• Stratified sampling• Convenience sampling• Judgment sampling• Quota sampling• Snowball sampling

Page 32: Basics of Technical Writing( Report )

Sampling methods• Probability1. Random2. Systematic 3. Stratified

• Non probability1. convenient2. Judgment3. Quota4. Snowball

Page 33: Basics of Technical Writing( Report )

Random• Random sampling is the purest

form of probability sampling. Each member of the population has an equal and known chance of being selected

Page 34: Basics of Technical Writing( Report )

Systematic• Systematic sampling is often

used instead of random sampling. It is also called an Nth name selection technique. After the required sample size has been calculated, every Nth record is selected from a list of population members.

• Systematic sampling is frequently used to select a specified number of records from a computer file.

Page 35: Basics of Technical Writing( Report )

Stratified • Stratified sampling is commonly used probability

method that is superior to random sampling because it reduces sampling error. A stratum is a subset of the population that share at least one common characteristic. Examples of stratums might be males and females, or managers and non-managers.

• Random sampling is then used to select a sufficient number of subjects from each stratum. "Sufficient" refers to a sample size large enough for us to be reasonably confident that the stratum represents the population. Stratified sampling is often used when one or more of the stratums in the population have a low incidence relative to the other stratums.

Page 36: Basics of Technical Writing( Report )

Convenience • This non probability method is often used

during preliminary research efforts to get a gross estimate of the results, without incurring the cost or time required to select a random sample.

• In convenience sampling, the selection of units from the population is based on easy availability and/or accessibility.

Page 37: Basics of Technical Writing( Report )

Judgment• usually an extension of convenience

sampling • a researcher may decide to draw the

entire sample from one "representative" city, even though the population includes all cities. When using this method, the researcher must be confident that the chosen sample is truly representative of the entire population.

Page 38: Basics of Technical Writing( Report )

Quota • the non probability equivalent of

stratified sampling • Like stratified sampling, the researcher

first identifies the stratums and their proportions as they are represented in the population. Then convenience or judgment sampling is used to select the required number of subjects from each stratum. This differs from stratified sampling, where the stratums are filled by random sampling.

Page 39: Basics of Technical Writing( Report )

Snowball • used when the desired sample

characteristic is rare • Snowball sampling relies on

referrals from initial subjects to generate additional subjects.

• Chances of bias as it may be less representative

Page 40: Basics of Technical Writing( Report )

Questionnaires

Page 41: Basics of Technical Writing( Report )

Why Questionnaires? • To maximize the proportion of

subjects answering our questionnaire - that is, the response rate.

• To obtain accurate relevant information for our survey.

Page 42: Basics of Technical Writing( Report )

Types of questionnaires

1.Open

2.Closed

Page 43: Basics of Technical Writing( Report )

Open format • Advantages of open format • Allows exploration of the range of

possible themes arising from an issue

• Can be used even if a comprehensive range of alternative choices cannot be compiled

Page 44: Basics of Technical Writing( Report )

Open format• Numeric open endHow much did you spend on groceries this

week?_______

• Text open end• How can our company improve its working

conditions?______________________

Page 45: Basics of Technical Writing( Report )

Closed format• Closed-that is, forced choice-format • Easy and quick to fill in • Minimize discrimination against the less

literate (in self administered questionnaire) or the less articulate (in interview questionnaire)

• Easy to code, record, and analyse results quantitatively

• Easy to report results

Page 46: Basics of Technical Writing( Report )

Testing

Page 47: Basics of Technical Writing( Report )

Types of closed format• Choice of categories• Likert style• Checklists• Differential• Ranking

Page 48: Basics of Technical Writing( Report )

Types of closed format• Choice of categoriesFor example( what is your marital

status)Single []Divorced []Married []Widowed []

Page 49: Basics of Technical Writing( Report )

Likert style scale• Statistics is an important subjectStrongly disagreedisagreeCannot decideAgree Strongly agree

Page 50: Basics of Technical Writing( Report )

Checklists“Circle the clinical specialties you are

particularly interested in”

• General medicine• General surgery• Pediatrics• Ophthalmology• Orthopedics• Accident and emergency• General practice

Page 51: Basics of Technical Writing( Report )

Differential scale

• How would you rate the puppet show?

Extremely interesting 1 2 3 4 5 6 7 8 9 10 extremely dull

How would you rate this product?Excellent ___Good ___Fair ___Poor ___

Page 52: Basics of Technical Writing( Report )

RankingPlease rank your interests in the

following specialties• General medicine• General practice• Orthopedics• Ophthalmology• Pediatrics• General surgery

Page 53: Basics of Technical Writing( Report )

Wording of individual

questions • Use short and simple sentences • Ask for only one piece of information at a

time

• Avoid negatives if possible Small group teaching should not be abolished

Small group teaching should continue

• Ask precise questions How often did you borrow books from your library?

How many books have you borrowed from the library within the past six months altogether?

Page 54: Basics of Technical Writing( Report )

• Ensure those you ask have the necessary knowledge

• Level of details • Sensitive issues • Minimize bias • Must be non-threatening

Page 55: Basics of Technical Writing( Report )

• accommodate all possible answers

What brand of computer do you own? __ A. IBM PC B. Apple ( possible other choice)

Do you own an IBM PC? (circle: Yes or No)

• What brand of computer do you own?(Check all that apply)

__ Do not own a computer__ IBM PC__ Apple__ Other

Page 56: Basics of Technical Writing( Report )

• There should be only one correct or appropriate choice for the respondent to make. An obvious example is:

Where did you grow up? __A. CountryB. farmC. city

Page 57: Basics of Technical Writing( Report )

• Does not presuppose a certain state of affairs

Are you satisfied with your current auto insurance? (Yes or No)This question will present a problem for someone who does not currently have auto insurance. Write your questions so they apply to everyone. This often means simply adding an additional response category.

• Are you satisfied with your current auto insurance?___ Yes___ No___ Don't have auto insurance

Page 58: Basics of Technical Writing( Report )

• Does not use unfamiliar words or abbreviations.

• Remember who are your audience. • Do not use uncommon words or

compound sentences. • Write short sentences. • Abbreviations are okay if you are

absolutely certain that every single respondent will understand their meanings

Page 59: Basics of Technical Writing( Report )

Length of questionnaire

• There are no universal agreements about the optimal length of questionnaires. However, short simple questionnaires usually attract higher response rates than long complex ones.

Page 60: Basics of Technical Writing( Report )

Arranging the questions The order of the questions is also

important. Some general rules are:

• Go from general to particular. • Go from easy to difficult. • Go from factual to abstract. • Start with closed format questions. • Start with questions relevant to the main subject. • Do not start with demographic and personal

questions

Page 61: Basics of Technical Writing( Report )

Introduction, personalized letter, and ending

• It seems a good idea to have either a personalized covering letter or at least an introduction explaining briefly the purpose of the survey, the importance of the respondents' participation, who is responsible for the survey, and a statement guaranteeing confidentiality. A personalized letter can be easily generated using mail-merge on a word processor. It is also important to thank the respondent at the end of the questionnaire.

Page 62: Basics of Technical Writing( Report )

Cover letter1. Describe why the study is being done (briefly)

and identify the sponsors.2. Mention the incentive. (A good incentive is a

copy of the results).3. Mention inclusion of a stamped, self-addressed

return envelope.4. Encourage prompt response without using

deadlines.5. Describe your "confidentiality/anonymity"

policy.6. Give the name and phone number of someone

they can call with questions.

Page 63: Basics of Technical Writing( Report )

Face to face interview

Page 64: Basics of Technical Writing( Report )
Page 65: Basics of Technical Writing( Report )

Don’t forget the most

important thing!!!!

Page 66: Basics of Technical Writing( Report )

Have loads of fun and enjoy what

you do !!!