answersLogoWhite

0


Best Answer

1. Always have in mind a specific reader, real or imaginary, when writing a report; and always

assume that this reader is intelligent, but uninformed.

2. Before you start to write, always decide what the exact purpose of your report is, and make sure that every paragraph, every sentence, every word, makes a clear contribution to that purpose, and makes it at the right time.

3. Use language that is simple, concrete, and familiar.

4. At the beginning and end of every section of your report check your writing according to this principles: "First you tell your readers what you are going to tell them, and then you tell them what have told them."

5. Make your report attractive to look at.

Here are additional 5 Tips on how to write a good capstone paper, since final exams are approaching and it will be about time for submission.

User Avatar

Wiki User

8y ago
This answer is:
User Avatar

Add your answer:

Earn +20 pts
Q: 5 basic principles of good technical writing?
Write your answer...
Submit
Still have questions?
magnify glass
imp
Continue Learning about Communications

Importance of technical communication?

Importance of Technical communicationTerm - Technical communication:Technical communication is the process of communicating our audience by providing informations about technical processes and products through media. The informations we provide will be purely technical. It will be relevant to the audience targeted. Technical communication is the responsibility of a professional to provide informations for coworkers and clients. This is possible only when he is well trained technically. This sometimes turns to be a professional task. Thereby, professionals will be hired for works to be done. They are technical writers. They do professional writing focusing certain group of audience. This type of writing which yields beneficial informations is referred as technical writing.Technical writing:Technical writing does not involve creativity greatly, since they are the factual details of products. Technical writers should be updated and be aware of the contemporary trend. This writing mainly relies on identifying our audience properly and understanding their requirements. If this is done correctly, half of the writer's job will be over. The accuracy level in this writing should be very high. Because audience will be tend to believe and make use of the informations in the long way of reading it. This is the most commonly used form of technical communication. Writers follow diplomatic style of writing."Technical writing is the presentation of information that helps the reader solves a particular problem. Technical communicators write, design, and edit proposals, manuals, web pages, lab reports, newsletters, and many other kinds of professional documents.Characteristics of Technical communication:Technical communication is different from that of general communication. It is purely concerned with well defined business activities. This is a perception of multi-cultural people. Technology which exists in Tamil Nadu will prevail as well as in Karnataka, Kerala etc.., People who live in Tamil Nadu use the same technology which is being used elsewhere. Only the methodology of implementing the technology will differ from one to other. It is the matter of freedom to express one's view. One who is confident and proficient in his subject can express and share his knowledge. It is also committed to principles that should not be over-ruled. Certain other characteristics are unambiguous, concise, courteous, and objective.Importance of Technical communication:Technical communication is essential in an organization, because it serves as a medium to share the informations. People who are working in a company should have a mutual understanding which can be attained by sharing their knowledge. This technical communication turns to be effective when researches are made and they are conveyed to each other. Students of today are given practice to apply the basic science and mathematics principles notably. They are being trained well in the theoretical and practically oriented aspects. Where goes the technical application?Technical communication is very significant for the practical application of sciences, for learning the mechanics in technology, for the promotion of technological research and for training the technical professionals. As the world is now confronting serious quandary due to the vibrant knowledge of technology, these kind of unrecognized jobs are being explored.Significance in engineering field:Engineering is a field, where students are being trained with practical and technical applications. Today, IT (Information Technology) companies are in need of these students but the cause of the need has changed. They wanted these people few years before for practical oriented jobs. Instead, now, they hire these students for technical tasks. The significance of these technical jobs is being increasing day-by-day. Predominantly, the training and the interest of engineering students lies in technical parts. Engineering students pursue their technical tasks, without getting necessary writing practices.Once they finish their studies, they go out and work as trained engineers in companies and industries, doing all the technical jobs. It might seem that they are doing a good job which is true in the technical aspect, but they actually lack in their writing and communication abilities. Unless they prove themselves among the co-workers, their technical skills will go unrecognized. If technical people cannot interact with others, about what they are doing, what exactly is it about; there is no use in being a technologist.Today in many companies and industries, many internal units are being established which were not in practice few years back. These internal units comprises of at least a marketing unit, a manufacturing unit, a design unit, a management unit and an engineering unit. As all these internal units focus towards the same end, engineers have the responsibility to out win the others. It is also their duty to transmit their works both verbally and in writing. For presenting their job effectively, influentially and understandably, they need good communication skill.When a survey is conducted to determine which academic skills are important for engineering careers, communication skills ranked the top comprising technical writing in the second place. When technical jobs are concerned, communication tasks like writing, public speaking, listening play a very major role. People in technical fields must be well trained to execute their knowledge in a very brief manner for the specialists and in the expanded form for the non-specialists. They should make understand even the non-technical people by their simple and neat work. The writers must be aware of what they are presenting, familiar with their technical terms, if they are, they can make people understand easily.The full meaning of a term can be expressed simply by 'unwinding' it from right to left and inserting the appropriate prepositions. For example, the term "wall stresses" could be expanded as "stresses on a wall," "stresses inside a wall," "stresses produced by a wall," etc. Only, the civil engineer can be sure that "stresses inside a wall" is correct. The interpretation is in the hands of the reader's knowledge on the subject being handled whereas the non-technical people get the intended meaning if the writer has done a good job. Thus, the significance of technical communication in the engineering field is noteworthy.Versatility of Technical communication:This communication is very essential in all the fields now-a-days, since everything is computerized today. Even though, all are striving to get that computer knowledge to their best, few cannot attain still. If the above said statement is true, it turns to be the responsibility of the people who have that knowledge, to train the others. This can be possible only through technical communication. Technical communication is important in any field of work where tasks are being done technically. If people have no technical knowledge, they cannot communicate with their co-workers. If they cannot communicate, they cannot exhibit their works done, which results in the technical errors and exploitation of their talents. When the versatility is concerned, technical writing stands out of the box significantly. It is a major part in many of the industries, though the necessity of technical writers is not appreciated. It is only now, those people are being recognized. No product would ever be successful, if the technical writing department does not exist.It is very useful even in the marketing department. The marketing people's job got over when their product got sold out. But after that, the information provided by the technical writing departments is useful in the installation, application, and daily use of that product. Even though, these technical writers work together with others, their thinking will be unique from them. Technical domains can be of any kind, including the soft and hard sciences, high technology including computers and software, consumer electronics, and business processes and practices.Technical communication jobs include the follow:· Technical writer· Technical editor· Technical illustrator· Information architect· Usability expert· User interface designer· User experience designer· Technical trainer· Technical translator· API writerLikewise, careers in technical communication are wide-spread.Careers:Careers in technical communication include writer, editor, web designer, indexer, production expert, graphic designer, reporter, usability expert, and many more job titles. Whatever your expertise and interest, you can find interesting work in the field. Also, most professional positions require excellent technical-writing skills. At some point in our careers, sometimes every day, we are all technical writers!Technical writing works involve the following,Installation Manuals, Maintenance Manuals, User Manuals, Quick Reference Guides, Glossaries, Indices / Indexes, Computer-based Training, Online Help, Release Notes, Desktop Publishing, Proofreading, Document Conversion.Conclusion:Communication skills comprises many, in which, this technical communication has a vivacious role to play irrespective of the fields. Hence, we realize its significance and pursue it in our career.


Was The ABC's of good letter writing are accuracy brevity and congratulation?

Accuracy, brevity, and clarity are the ABCs of good letter writing.


What are qualities of a good letter writing?

There are many qualities of good letter writing. These qualities include addressing the person professionally, good grammar, and precise information.


What is coherence of technical writing?

Coherence is the unifying element in good writing. It refers to the unity created between the ideas, sentences, paragraphs and sections of a piece of writing. Coherence is what gives a piece of writing its flow. It also gives the reader a sense of what to expect and, therefore, makes the reading easier to follow as the ideas appear to be presented in a natural, almost automatic, way.When writing lacks coherence, the reader is forced to stop and reread. Occasionally, the reader may just give up out of frustration.Definition:A quality of sentences, paragraphs, and essays when all parts are clearly connected. Adjective: coherent.


Characteristics of technical writing?

ClarityIt is essential that the technical writer understands the reader's background and needs. Making the documentation too technical can confuse the reader. The document is meaningless if the intended audience does not understand what the writer wants to communicate. Writers who are well aware of their audiences are in a position to give a solution to their problems. The profession of technical writing demands simplicity of language and clarity of expression. One must avoid unnecessary words that may put the readers in a quandary. The written document must be clear and concise so that the text becomes easier to grasp and understand.DescriptivenessElectronic products such as digital cameras or VCRs often come with manuals that tell how to operate it. As the customers may come from a non-technical background, care must be taken that the manual is not difficult to understand. Certain key concepts to operate the product must be explained as easily as possible for the targeted readers. If your use pure jargons, the customer will possibly never know what you want to say. Explaining the product in layman's terms is absolutely necessary. Good technical writing conveys ideas in the most effective manner. A well-written technical document always contains answers to anticipated problems in the product or application. This aspect of technical writing is commonly seen in articles that are related to troubleshooting a particular software or product.AccuracyAccuracy is an important characteristic of any technical document. A slight mistake can have grave consequences. For instance, if you forget to mention some important features of a new mobile phone, the customers may think that there is nothing special in that phone and will not prefer to buy it. Effective communication requires quality content and language that is accurate and readable. Technical writing does not mean that you translate information unquestioningly. In this profession, one must know for whom the document is being written and whether it is accurate.CorrectnessThe grammatical structure of your technical document should be correct and free from any kind of ambiguities. The intended meaning will not be communicated to the reader if the document has ambiguous sentences. A well-organized document that makes use of headings and sub-headings is not only pleasing to the eye but will also helps the reader to find specific information in a short time.

Related questions

What are the basic principles of good technical writing?

by Catherine HibbardIf you take a technical writing workshop, the materials will address numerous areas; some are very specific while others are more general in nature. A good starting point is to look at six principles of technical writing. Reviewing these basics can provide a great platform from which we can launch forays into specific areas of interest and documentation.Use Good GrammarWrite ConciselyUse the Active VoiceUse Positive StatementsAvoid Long SentencesPunctuate Correctly


What are the principles of technical writing?

The first principle of technical writing is good grammar. Write concisely â?? no fluff. Always use active voice in your writing. Always use positive statements. Avoid long run-on sentences. Last but not least, always use the correct punctuation.


The basic principles of good technical writing?

1. Writers should always have in mind a specific reader, real or imaginary, when writing their report and always assume that they are intelligent but uninformed. 2. They should decide on their exact purpose in writing. 3. They should use simple, concrete and familiar language. 4. They should check/review their writing from time to time. 5. They should make the paper as neat and as attractive as possible.


Do you need to be good at writing papers in order to work for computer technical support?

NO


What is a statement that best explains how the author of a transaction feels about writing?

Writing is difficult but the basic principles of good writing can be learned. Writing is difficult and writers use different methods in order to be successful. Clear writing does not happen by accident and requires hard work. Answer: He enjoys writing but admits that it is difficult to master.


Identify two ethical principles that should guide technical communications Explain each of the principles you chose and provide an example of why each is important?

Two ethical principles that should guide technical communications are honesty and accuracy. Honesty entails providing truthful and reliable information without exaggeration or omission. It is essential to maintain trust and credibility with the audience. Accuracy emphasizes the importance of providing information that is precise, reliable, and supported by evidence. This principle ensures that the audience can make informed decisions or take proper actions based on the information received. For example, in product documentation, being honest about potential limitations or risks can prevent customers from making uninformed choices and potentially causing harm.


What are the basic principles and good technical writing?

Six Principles of Technical WritingIf you take a technical writing workshop, the materials will address numerous areas; some are very specific while others are more general in nature. A good starting point is to look at six principles of technical writing. Reviewing these basics can provide a great platform from which we can launch forays into specific areas of interest and documentation.1. Use Good Grammar2. Write Concisely3. Use the Active Voice4. Use Positive Statements5. Avoid Long Sentences6. Punctuate CorrectlyPrinciple One: Use Good GrammarYour readers expect technical documents to be written in standard English. Certain grammatical errors can actually cause your reader to misinterpret the information. However, because technical documents must be precise and accurate, readers expect documents to be professional, polished, and flawless. Principle Two: Writing ConciselyIn technical writing, clarity and brevity is your goal. Principle Three: Using the Active VoiceImperative sentences, or command sentences, are written in the active voice. The active voice is more natural to people when they speak, but technical writers often turn to the passive voice when writing technical documents. One of the main reasons you should use the active voice rather than the passive in technical writing is the active voice more closely resembles the way people remember and process information. Principle Four: Using Positive StatementsTechnical writers should word instructions as positive statements. Whenever possible, phrase commands in a positive manner. Principle Five: Avoiding Long SentencesShort sentences are easier to understand than long sentences. For this reason, it is best to write your technical documents in short sentences. If you are asking your readers to perform several actions, begin the step with an active verb. This highlights the action itself Principle Six: Using Standard PunctuationYour readers expect standard punctuation when they read your documents. Complicated or "creative" punctuation will confuse them. One suggestion is to select syntax that minimizes the need for punctuation. You may wish to divide compound or complex sentences into shorter sentences to avoid excessive or confusing punctuation.


What is the difference between technical writing and academic writing?

Technical writing is focused on providing information or instructions related to a specific task, product, or process, often for a specialized audience. Academic writing, on the other hand, involves the exploration and analysis of theories, concepts, or research findings within a particular field, typically for an academic audience. The tone, style, and purpose of the two types of writing can vary based on their intended audience and objectives.


Please provide me few Tech Writing institute which provides Technical Writing training?

Hi, You can approach Black and White Tech Writing Solutions, which is in Bangaore, they provide training on Technical writing, where the course goes on for 2 to 3 months. check out their website www.bwtechwriting.com / you can reach them at 9986662740 Good Day!


What is the difference between technical writing and technical communication. Can anyone give me information of good institutes in Hyderabad where these training are given?

Technical communication is a method of researching and creating information about technical processes or products directed to an audience through media. The information must be relevant to the intended audience. Technical writing, a form of technical communication, is a style of writing used in fields as diverse as computer hardware and software, engineering, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology.


Is the APA style most appropriate for technical writing?

APA style is certainly a good choice for most appropriate in technical writing (I am an engineer and that is the style I had to use). It will depend on the requirements of the person or institution that will be the final authority on what style is required for your work.


What is Difference between technical writing and academic writing?

Subject: Academic vs. technical writingFrom: Chaim Chatan Date: Fri, 27 Mar 1998 16:29:29 +0200Since there is a discussion of the differences between academic writing andtechnical writing, let me give you the perspective of someone who has doneboth. There are very important differences between academic and technicalwriting. One must also realize that there are also different types ofacademic writing and different types of technical writing.First of all, the purposes and audiences are different between academic andtechnical writing. The purposes of academic writing can be: 1) to presentthe results of one's knowledge, 2) to present the results gained from one'spersonal research, and 3) to present one's point of view. Of course, bothtechnical and academic writing is laden with jargon, but the jargon is usedfor different purposes. As far as technical writing is concerned, thepurposes of technical writing can be: 1) to teach someone how to use aspecific product or service; and 2) to describe the procedures that areemployed by companies for carrying out various tasks.The audiences are completely different. The academic is writing to fellowscholars, and often, depending on the journal or publication, to thegeneral public. The technical writer is writing to the user of the productor the service, or to government inspectors who need to see how the companycarries out certain tasks. Users, of course, differ from product toproduct. In addition, technical writing differs from area to area. Forexample, writing documentation for software is different from writingdocumentation for hardware.When I took a technical writing course as part of my professionalretraining, I had to unlearn a lot of what I had been doing as an academicwriter. We are dealing with different styles of writing altogether. Also,there is good and bad academic and technical writing, and a good academicwriter may not become a good technical writer and vice versa. I have seendownright awful academic writing, where the author wrote extremely unclearand obscure prose, and I have seen extremely garbled technical writing,where it was difficult to follow the instructions.The important variable here is teachability. If an academic writer whowants to become a technical writer is not teachable, especially coming fromthe academic and liberal arts world, he/she will not be a good technicalwriter. Good academic writing is not enough--teachability is the mostimportant factor. One of the most important tasks of interviewers ofcandidates for technical writing jobs, especially candidates who have nothad professional experience, is not just simply to look at the writingsamples of the candidates, but to assess how teachable they are. If thecandidate has both academic and technical writing samples, the interviewershould be able to assess whether the candidate has grasped the differencesbetween the two types of writing. This is one way to measure teachability.A bit of advice for academics who want to go into technical writing is toperuse all the various types of manuals and documentation written bytechnical writers to get a sense of what is involved in technical writing.