Chapter 1

Stages of report preparation

Technical writing introduces you to some of the most important aspects writing in the world of science technology and business.

Technical reports includes:1- report 2- research paper 3- experience paper

The 5 major stages of report preparation :12345gathering the data analyzing the results outlining the report writing the rough draft revising the rough draft

Guide for writing technical report :1- Subject: technical report writing about. 2- Scope: covering the fundamentals organizing, writing and reviewing technical reports. 3- Purpose: was written to improve the writing skills or technical authors and overall quality of their reports.

Outlining the report:1- logical organized 2- concise 3- easy to read

From Eng_Bahaa_cd for Monatadaeng.com

(Technical Reports) (1)

Reports contain a number of commonly used headings:1- abstract 2- introduction 3- symbols 4- theory 5- analysis 6- test specimens 7- sample calculations 8- Results & discussions 9- Summary of results 10- Conclusions 11- Concluding remarks 12- Appendix 13- References

Writing the rough draft:1- Try to start writing the first version of the draft immediately after completing the outline while the ideas developed are still fresh in your mind. 2- Write the first version as fast as possible. 3- Concentrate on what you want to say rather than how to say it . 4- Keep writing down the thoughts as they flow into your mind following your outline. 5- Avoid going back over what you have written until you are through writing . 6- Review this version, but only for technical contents. 7- Are all the ideas that you wanted to express included? 8- Does the report organization still seem logical?

Revising the rough draft:1- First review is the material in the report. Are the conclusions valid? Is sufficient information given to support the conclusions? Is enough background information given to explain the results? 2- Second review the mechanics & organization. Are he subject and purpose clearly stated? Does the report flow smoothly from topic to topic? Is the relation between the topics clear? 3- Third review spelling and grammar.

From Eng_Bahaa_cd for Monatadaeng.com

(Technical Reports) (2)

Chapter 2
Report style
No assurance that a person thinks clearly, will be able to writ clearly. No infallible guide to good writing. No inflexible rule by which the young writer may shape his course. A writing style is acquired only with deligent study and practice in writing

Report requirement:1234clarity conciseness continuity objectivity

clarity : 1- The purpose of a technical report is to transmit conclusion and their supporting evidence to do this: 2- Your report must convey your exact meaning to the reader. 3- The mathematical symbols must be fully defined & the figures, tables must be fully understood. 4- The text must be clear to the reader point of view. 5- You must re-examine your rough draft with a reader's critical eye. Conciseness : Most of the readers are busy there for the report must be concisely written. 1- Story should be told with fewest possible words and illustration. 2- Omit every thing irrelevant to results and conclusions. 3- Give enough information to enable the reader to understand clearly. 4- Include all details needed to understand the report. 5- Don't assume that the reader will remember the details of previous information. 6- Make your report brief but comprehensible.
Continuity :

1- Reports should tell a complete story as logically and interesting as possible. 2- This is requires continuity between succeeding sentences, paragraphs and sections and between the written text the figures and tables. 3- Carefully choose the place at which you refer to figure and tables to limit distraction.
From Eng_Bahaa_cd for Monatadaeng.com (Technical Reports) (3)

 Objectivity :

1- Be honest with your readers. 2- Don't try to hide deficiencies. 3- Tell your reader what are your assumption what are your probable errors and what you didn't understand from result.

Guiding the reader:1- Tell readers what you plan to tell them "introduction". 2- Then tell them main text. 3- Finally tell them what you told them "summary of results and conclusions ".

Separating between fact and opinion:1- It's believed that . 2- From the results, I conclude that ..

How to build better surveys:1234Start with questions which will give you a quick answer. Provide extra space for comments and extra information. Use familiar rating scales 15 or 110. Avoid numerical rating and use words instead "poor, fair, good, very good, and excellent".

How to write a useful abstract:1- Write a topic sentence. 2- Write two or three supporting sentences. 3- Tie everything together with logical order and good transition.

How you do it "topic sentence":1- After you have finished writing, sit back and think about the whole document, its major idea, its main conclusions or result it is primary purpose. 2- Think about what you expect the reader to do with this document. 3- Collect all this together in your mind and write a sentence. 4- Don't depend on the title of the document as at may not help you. 5- Make the topic sentence actually say specific things about the project.

Tricks to write on abstract:1- Write the abstract after the document is written. 2- Define the scope of the project in the abstract. 3- Reread your abstract several days after you wrote it.
From Eng_Bahaa_cd for Monatadaeng.com (Technical Reports) (4)

Data presentation:1234Use only figures and tables that add to the value of the report. Present the table as simply as possible. Don't present data in more than one way. Use only data that are directly related conclusions.

Equations and symbols:123451234Equation will be concentrated on the page. Equations will be numbered on the right enclosed in parenthesis "1". Don't substitute numbers into equations. Equations will be treated as part of sentence. Important equations will be displayed separately from the text. Plot your data in figures as possible. Tables must be referenced in the text. Tables should be as simple as possible. Each table must have a subscript above the table that explains the meaning of the table. Must be as simple as possible.

Tables:-

Grammar:Figures:12345Must have a clear description below the figure. Figures must be referenced in the text. Graphs must have a clear label on each axis that includes units. Figures will be numbered consecutiuly in Arabic numerates. The size of the printed figure including the legend can't exceed the dimensions of the report.

Numerals:For ease in reading numbers of five or more digits , group of them in threes from decimal separate then by spaces and not commas "ex 10 091".

General guidelines of graphicsa review:1- Use graphics whenever they would normally be necessary. 2- If certain graphics are difficult to produce, discuss the problem with your instructor. 3- Use figure titles for all graphics.
From Eng_Bahaa_cd for Monatadaeng.com (Technical Reports) (5)

4- Indicate the source of any graphs. 5- Include identifying details such as label. 6- Don't movably add color or any other details on the page of the final copy.

Chapter 3
Report introduction
Relation to rest of report:1- Introduction should focus the reader's attention on the subject to be treated. 2- The introduction clears now the body of the report will develop. 3- it answer these questions were the data produced and analyzed : Results summarized? Was there an initial theoretical model? Were conclusions drowning? Are comparisons mode?

Primary functions:1- Statement of the subject. 2- Statement of organization and scope. 3- Statement of purpose. Statement of subject :1- First of the introduction is to identify immediately and unmistakably the exact subject of the report. 2- It's necessary to define the subject in order to prevent any misunderstanding. statement of purpose :1- States clearly the reasons for discussing the particular. 2- Indicates important of the subject of the report. 3- Relates report to previous and similar work. 4- Few key references are available to tie the new work to the prevision Statement of organization and scope :Readers should know at the outset the scope and limitations of the work.
From Eng_Bahaa_cd for Monatadaeng.com (Technical Reports) (6)

Secondary functions:The introduction should mention any unusual aspects a report such as film , vide tape , microfiche or computer program, supplement, a supplementary report , or any appendix prepared by another author.

Style and length:1- The introduction style may vary within certain bounds. 2- The limits imposed are that the language be direct clear and accurate. 3- The primary function should be built into a few paragraphs of expository writing in style will be both pleasant to read any very clear. 4- 200 to 300 words is the usual length of an introduction per page 5- The length of the introduction depends on how much background

Writing a good introduction:1- A good introduction is fairly formulaic. 2- If you follow a simplest of rules , you can write a very good introduction Paragraph 1: motivation; what is the problem up are working and why is it important and what is its importance to the larger community? Paragraph 2: what is the specific problem considered in this paper? Paragraph 3: this is the key paragraph in the introduction you summarize in one paragraph what are the main contributions of your paper give the content you established in the 1st two paragraphs. This paragraph must be really good. Paragraph 4: what are the differences in what you are doing and what other has done? Paragraph 5: give the reader a road map for the rest of the paper.

From Eng_Bahaa_cd for Monatadaeng.com

(Technical Reports) (7)

Chapter 4
Experiment and analysis descriptions
Formatting experiment descriptions:1- apparatus 2- test procedure 3- test specimen

Apparatus:A new test facility should be described in sufficient details. A good initial description that can be referenced may greatly simplify future reports.

Instrumentation section:1- Discussion of instrumentation may be organized to natural flow paths through the test facility. 2- Photographs or drawings may show the position instruments. 3- A specialized instrument may require more detailed description.

Materials section:Test materials should be characterized in detail, including the purity of the material , its grain size and density

Test procedure section:1- In describing test it's helpful to begin with an inductor paragraph. 2- The conditions studied can usually be described clearly a few sentences but may be sufficiently numerous or complex to warrant listing in a table.

Format of analysis descriptions:The analysis sections in the main text includes:1- Statement of the problem. 2- Assumptions and limitation of the analysis. 3- Brief description of the general analytical method.

In preparing an analysis section, on the following terms:1- All numbered and most unnumbered equations are centered between margins and set off from the test by spacing. 2- The equation and the introduction material that directly precedes it should be present in correct grammatical from. 3- Equation needed for later reference is numbered "1","2".
From Eng_Bahaa_cd for Monatadaeng.com (Technical Reports) (8)

Symbols section:Symbols must be put after the abstract.

Errors & precision:The accuracy, precision and reproducibility of the data must be clearly stated. Discrepancies of the data should be explained.

Chapter 5
Results and discussion
The first purpose of this section is a well organized and objective representation of the results. Tables and figures that show the results should have sufficient supporting description. Don't repeat words what is already clear from the examinational tables and figures. The second purpose of this section is a discussion of the results. Each major conclusion should be explained and coopered with results of the similar wrote by other investigations.

Organization of section:1- The results and discussion section should present the data as concisely and clearly as possible. 2- Prepare a good outline of this section before starting to write. 3- An introduction statement is used to remind of the type of tests conductor and scope of the investigation. 4- Regale of the length of the report, a single section combining the results and their discussions is usually preferable because this scheme is clearer on less repetitious "results and discussion section". 5- Separate sections are desirable when heterogeneous data mute be considered in making a point in the discussion.

From Eng_Bahaa_cd for Monatadaeng.com

(Technical Reports) (9)

Chapter 6
Concluding and supporting sections
Acknowledgments:Appendixes An appendix should be regarded as the place for material that is important but not essential to the complete development of the report. Particularly appointee for appendixes are: 1- Involved mathematical deviations. 2- An example of analysis described in the report. 3- Detailed descriptions of novel techniques, procedures or equipment not essential to the main purpose of the report.

References:A reverence may be appropriate: 1- Show work penitent to the subject. 2- To acknowledge the work of others in the some field, particularly quotations. 3- To save repetitions apparatus or procedures, development theories or other information. 4- To support your assumptions, reasoning, view point or explanations other information.

From Eng_Bahaa_cd for Monatadaeng.com

(Technical Reports) (10)