Verified Document

Technical Writing Process The Objectives Research Paper

Related Topics:

The writer will then be ready to write a first draft where the outline is expanded into paragraphs (Introduction to technical writing/documentation) and a glossary of terms is created (The technical writing process). The writer will then revise the first draft, including checking for completeness and accuracy, checking that writing is clear and concise, proofreading with spelling and grammar checks, reviewing mechanics such as abbreviations, acronyms and initialisms expansion after their first usage (Introduction to technical writing/documentation) and making sure that the correct working is used for copyright notices of any third-party products (The technical writing process). A third-party proofreader is a good idea if someone is available for this task. The writer will also want to send the documentation to a subject-matter expert for a technical accuracy check and make the requested corrections (The technical writing process). The final process is documentation delivery to users. Sub-steps depend...

Parts of this document are hidden

View Full Document
svg-one

For example, documentation integrated with the application will need to be coordinated with the system architect; CD documentation requires burning; and labeling CDs and printed documentation involves binder insertion with required tab separators, spines and covers (The technical writing process).
In summary, planning, writing and documentation delivery are the three major processes the user manual will require. These processes will make certain that the writer knows what users need from the documentation, creates the right content to meet those needs and makes the information available on the right medium in the correct format.

Bibliography

Introduction to technical writing/documentation. http://www.perlmonks.org/?node_id=130249

Objectives in technical writing. http://wps.prenhall.com/hss_gerson_techwrite_4/0,4315,151927-,00.html

The technical writing process. http://www.docsymmetry.com/technical-writing-process.html

Sources used in this document:
Bibliography

Introduction to technical writing/documentation. http://www.perlmonks.org/?node_id=130249

Objectives in technical writing. http://wps.prenhall.com/hss_gerson_techwrite_4/0,4315,151927-,00.html

The technical writing process. http://www.docsymmetry.com/technical-writing-process.html
Cite this Document:
Copy Bibliography Citation

Related Documents

English Law Negligence in Hospital Care The
Words: 1888 Length: 6 Document Type: Case Study

English Law Negligence in Hospital Care? The Case of Jenny Wants a Penny Duty of care is defined in different ways depending on the specific circumstances involved in any one case, according to precedents set in various tort cases. In one of the most famous of these cases, Donoghue v Stevenson [1932] UKHL 100, Lord Atkin set out the principle that all members of society owe a duty of care to their "neighbors"

English I Agree With the Statement That
Words: 1224 Length: 4 Document Type: Essay

English I agree with the statement that English is the world's most important language. The importance lies in the breadth of English spoken, rather than the depth. In addition, English is already understood to be the world's de facto second language. Removing English from dominance would require the emergence of another language whose prominence could match it. Lastly, English is the most important language and will continue to be because of

English Civil War As a Background to Milton's Paradise Lost
Words: 2305 Length: 6 Document Type: Essay

English Civil War as a Background for Milton's Paradise Lost Political Foundations in Milton's Paradise Lost: Ties to the English Civil War Paradise Lost is an epic tale of defeat and the consequences which come from breaking with the proper form of divine rule. In his work, John Milton pits Satan and his army against God in Heaven, illustrating the notorious Christian battle within particularly political contexts. The English Civil War did

English for Oral Communication -Problems Faced Oral
Words: 2756 Length: 9 Document Type: Essay

ENGLISH FOR ORAL COMMUNICATION -Problems faced oral presentation ways overcome problems Sales Marketing staffs. Problems faced in oral presentation and how to overcome them Many a time sales and marketing staff members are required to give oral presentations to existing and potential clients. These presentations may range from short to long while others include visual aids and are in slide format, they can also be done individually or by a group of

English Poems the Problem Regarding Racial Equality
Words: 1004 Length: 3 Document Type: Thesis

English Poems The problem regarding racial equality can be traced as far back as the African-American slave trade of the 1400s. But even after the Civil War and the Reconstruction of the United States, there is no denying the fact that a racial tension still exists between "whites" and "blacks." Many authors, artists, and poets have portrayed this tension, sometimes even going as far back as inspiring their audience through language

English As the Global Language
Words: 2993 Length: 9 Document Type: Essay

Dovring makes a good point when she says that it is difficult for a person to free their self of their own communication realm (Dovring, 115). However, Dovring goes on to say that individuals who are required to learn a language other than their own for purposes of communicating with others, can cause them to become victims the language they acquire (Dovring, 115-116). It can, Dovring says, alter not just

Sign Up for Unlimited Study Help

Our semester plans gives you unlimited, unrestricted access to our entire library of resources —writing tools, guides, example essays, tutorials, class notes, and more.

Get Started Now