answersLogoWhite

0


Best Answer

Importance of Technical Report Writing For Software Engineer

In Software Engineering, one of the major forms of communication is the Technical Report Writing. This is the conventional format for reporting the results of your research, investigations, and design projects. At university, reports are read by lecturers and tutors in order to assess your mastery of the subjects and your ability to apply your knowledge to a practical task. In the workplace, they will be read by managers, clients, and the software engineers responsible for software from your code designs. The ability to produce a clear, concise, and professionally presented report is therefore a skill you will need to develop in order to succeed both at university and in your future career.

Engineers spend a great deal of time writing technical reports to explain project information to various audiences.

While reports vary in the type of information they present (for example, original research, the results of an investigative study, or the solution to a design problem), all share similar features and are based on a similar structure or software.

The Importance of Writing

Many Engineers (software) spend between 1/3 and 1/2 of their work time engaged in Technical Writing. Examples include:

Ø

Proposals

Ø

Regulations

Ø

Manuals

Ø

Procedures

Ø

Technical Reports

Ø

Progress reports

In order to be successful, an Software Engineer must be able to write effectively.

Poor writing makes the reader question the abilities and dedication of the writer, and can keep an engineer from advancing in his or her career.

Technical writing

is a type of expository writing this is used to convey information for technical or business purposes.

Technical writing

is NOT used to:

Ø

Entertain

Ø

Create suspense

Ø

Invite differing interpretations

Some Things To Keep In Mind When Doing Technical Writing

There are some something that is important for technical writing .

Ø

Understand the type of report/memo you are writing—find examples and notice the structure of Software.

Ø

Think about your readers' knowledge and needs—this is crucial! Try to imagine what the reader knows and expects from such a text

e.g when you buy software then always there some txt that for help for you to get useful information and use that software.

Ø

Keep your list items or points short

.

Ø

Once you have a draft, ask some readers for Feedback—at this point you're interested in what meaning they make, you're not interested in editing help, so be sure to let them know what information you're looking for

Ø

Use examples and illustrations; consider tables and visuals that might explain your arguments

Basic structure of a report

A report usually has these components:

Ø

Title page

Ø

Summary

Ø

Table of Contents

Ø

Introduction

Ø

Middle sections with numbered headings(i.e., the body of the report)

Ø

Conclusions

Ø

References

Title page

This page gives:

Ø

the title of the report

Ø

the authors' names and ID numbers

Ø

the course name and number, the department, and university

Ø

the date of submission.

The title of the report should indicate exactly what the report is about. The reader should know not only the general topic, but also the aspect of the topic contained in the report. Compare the following pairs of titles:

Bridge Analysis

vs.

Analysis of a Prestressed Concrete Bridge

internet-based ATIS

vs.

An Evaluation of Internet-based Automated Traveller Information Systems

Summary

The summary provides a brief overview of the substance of the report; usually no more than half a page. It is not an introduction to the topic. The summary should outline all the key features of your report, including the topic, what you did and how you did it, and the main outcomes of your work. A busy ADMINISTRATOR who might not have time to read the full report should be able to get the gist of the whole report by reading the summary.

The summary:

Ø

states the topic of the report

Ø

outlines your approach to the task if applicable

Ø

gives the most important findings of your research or investigation, or the key aspects of your design

Ø

states the main outcomes or conclusions

Introduction

The introduction provides the background information needed for the rest of your report to be understood. It is usually half to three-quarters of a page in length. The purpose of the introduction is to set the context for your report, provide sufficient background information for the reader .

Table of contents

The contents page sets out the sections and subsections of the report and their corresponding page numbers. It should clearly show the structural relationship between the sections and subsections. A reader looking for specific information should be able to locate the appropriate section easily from the table of contents. The conventions for section and page numbering are as follows:

  • Number the sections by the decimal point numbering system:

1.0

Title of first main section (usually Introduction)

1.1

First subheading

1.2

Second subheading

2.0

Title of second main section

2.1

First subheading

2.2

Second subheading

2.2.1

First division in the second subheading

2.2.2

Second division in the second subheading

Conclusions

The conclusions section provides an effective ending to your report. The content should relate directly to the aims of the project as stated in the introduction, and sum up the essential features of your work. This section:

  • states whether you have achieved your aims
  • gives a brief summary of the key findings or information in your report
  • highlights the major outcomes of your investigation and their significance.
Referencing

The two parts to referencing are:

  • citations

    in the text of the report

  • a

    list of references

    in the final section

A

citation

shows that information comes from another source. The

reference list

gives the details of these sources. You need to use in-text citations and provide details in the references section

User Avatar

Wiki User

11y ago
This answer is:
User Avatar

Add your answer:

Earn +20 pts
Q: What is the importance of technical report writing in the field of mechanical engineering?
Write your answer...
Submit
Still have questions?
magnify glass
imp
Continue Learning about Mechanical Engineering

What is the function of lead in mechanical pencil?

. it serves as the writing point of the pencil


Mechanical Pencils?

form_title= Mechanical Pencils form_header= Need a writing utensil? Purchase mechanical pencils. Do you want your company logo on the pencils?*= () Yes () No What color do you want the pencils?*= _ [50] How many pencils do you need?*= {10, 20, 30, 40, 50, More than 50}


Which architectual and engineering innovations most influenced the development of the skyscraper?

Im not for sure so plz use another site and someone plz update this. Some freak keeps writing things that dont answer the question. Sorry thanks for reading :)


Subjects needed for mechanical engineering?

I think Physics , Chemistery , Mathematics , Bio-logy are the subjects needed.Another Perspective:That depends on the institution. Some of the local community colleges or technical schools will just focus on the math and physics. A University will have standards which represent a minimum level of education required for graduation. For example:you can learn how to calculate loads for a specific span using different materials by simply attending a physics class and having the basic math skills necessary for that class.But if you are attending a University and plan to graduate with your degree, you'll also need to know how to communicate with others, so they will require English writing skills.You may be required to understand some of the computer programs available to assist with design AND document writing.They will want you to know a little about people, so they may have requirements about psychology, biology, organic chemistry and other subjects.They may want their graduates to be able to converse with other educated people, so they may require literature and art.They may want you to be able to take care of yourself, so they may require health classes and physical eduction.


What does expository writing mean?

You you you

Related questions

What is the importance of judgment in technical writing?

importance of judgement in techinacl writing


What is the importance of definition in technical writing?

eeee


What isthe importance of technical writing?

the most importance is the software industry..


Meaning of mechanical neatness in technical writing?

Mechanical neatness means that the technical writing is neat and concise in form. The margins, headings, and sub-headings have all been paid attention to.


What has the author Kenneth A Kobe written?

Kenneth A. Kobe has written: 'Chemical engineering reports' -- subject- s -: Chemical engineering, Report writing, Technical writing


Importance of technical writing in industrial engineering?

Technical writing, like all genres of writing, takes discipline and practice. Understanding the basics of technical writing can help a student understand whether or not this niche is interesting and challenging enough to encourage a student to pursue it in life, as a career, for example.


What is the technical aspect of a feasibility study?

Technical writing refers to a type of writing where the author outlines the details and operations of administrative, technical, mechanical, or scientific systems. The main goal of technical writing is to educate, direct, and give others the ability to use a certain system.


What is importance of technical writing in maritime profession?

The importance of technical writing in the Maritime Profession is that seafarers may be able to write formal letters and/or communications and other forms of communication in print comprehensively either externally or internally.


What is an example of technical writing?

Technical writing is done to inform and educate people. The author outlines details and operations of scientific, technical, mechanical, or administrative systems so others can use a system. Examples of technical writing include operating manuals for games, computers, or other devices.


Importance of brevity in technical writing?

Brevity is important in technical writing because the format serves a specific purpose. One must deliver the information clearly without being redundant.


Is it true that if you're good at math but bad at writing papers you will fail physics and engineering?

No, that is not true. But it helps to do good in writing so you can explain and document the facts and results of physics and engineering. I hated to write essays in school, but now I enjoy writing technical memos in engineering, so do your best


What is mechanical neatness?

Mechanical neatness means to make a report or technical writing concise and neat in appearance. It means having neat headings, sub-headings, and margins.