Open main menu
Home
Random
Recent changes
Special pages
Community portal
Preferences
About Wikipedia
Disclaimers
Incubator escapee wiki
Search
User menu
Talk
Dark mode
Contributions
Create account
Log in
Editing
Technical communication
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
===Revising and editing=== Once the initial draft is laid out, editing and revising can be done to fine-tune the draft into a final copy. Usability testing can be helpful to evaluate how well the writing and/or design meets the needs of end-users and to suggest improvements [<ref>{{Cite book |url=https://www.worldcat.org/oclc/783150285 |title=Solving problems in technical communication |date=26 December 2012 |others=Johnson-Eilola, Johndan., Selber, Stuart A. |isbn=978-0-226-92406-9 |location=Chicago |oclc=783150285}}</ref>] Four tasks transform the early draft into its final form, suggested by Pfeiffer and Boogard:{{citation needed|date=October 2012}} ====Adjusting and reorganizing content==== In this step, the writer revises the draft to elaborate on topics that need more attention, shorten other sections—and relocate certain paragraphs, sentences, or entire topics. ====Editing for style==== Good style makes writing more interesting, appealing, and readable. In general, the personal writing style of the writer is not evident in technical writing. Modern technical writing style relies on attributes that contribute to clarity: headings, lists, graphics; generous white space, short sentences, present tense, simple nouns, [[active voice]]<ref>[[Gary Blake]] and [[Robert W. Bly]], ''The Elements of Technical Writing'', pg. 63. New York City: [[Macmillan Publishers (United States)|Macmillan Publishers]], 1993. {{ISBN|0020130856}}</ref> (though some scientific applications still use the [[passive voice]]), second and third person as required Technical writing as a discipline usually requires that a technical writer use a [[style guide]]. These guides may relate to a specific project, product, company, or brand. They ensure that technical writing reflects formatting, punctuation, and general stylistic standards that the audience expects. In the United States, many consider the ''[[Chicago Manual of Style]]'' the bible for general technical communication. Other style guides have their adherents, particularly for specific industries—such as the ''Microsoft Style Guide'' in some information technology settings. ====Editing for grammar and punctuation==== At this point, the writer performs a ''mechanical edit'', checking the document for grammar, punctuation, common word confusions, passive voice, overly long sentences, etc.
Edit summary
(Briefly describe your changes)
By publishing changes, you agree to the
Terms of Use
, and you irrevocably agree to release your contribution under the
CC BY-SA 4.0 License
and the
GFDL
. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel
Editing help
(opens in new window)