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 writing
(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!
==Overview== {{further|Technical writer}} Technical writing is most commonly performed by a trained [[technical writer]] and the content they produce is the product of a well-defined process. Technical writers follow strict guidelines so the technical writing they share appears in an uniformly standardized and popularly used format and style (e.g., [[Darwin Information Typing Architecture|DITA]], [[markdown|markdown format]], [[AP Stylebook]], [[Chicago Manual of Style]]). A technical writer's primary job is communicating technical information in the most clear and effective way possible.<ref name="Mike Markel 2012">{{cite book|author=Mike Markel|title=Technical Communication 10th Edition|publisher=Bedford/St. Martins|year=2012}}</ref>{{rp|p=4}}<ref>{{Cite web |title=Technical Writers: Occupational Outlook Handbook: U.S. Bureau of Labor Statistics |url=https://www.bls.gov/ooh/media-and-communication/technical-writers.htm#tab-1 |access-date=2024-02-14 |website=www.bls.gov |language=en-us}}</ref> To achieve the highest level of clarity, an organization's technical writing should be indistinguishable to the reader - with no variations in the established format, grammar, and/or style between authors. A technical writer's subject matter is often complex, so strong writing and communication skills are essential. Technical writing is in no way limited to written communication. [[Visual communication]] is often incorporated into documentation to help simplify complex topics. Technical writers use various modern image and graphics editing software to produce visual communication. Software to edit [[illustration]]s, diagrams, and [[CAD]] explosions are common tools of the trade.<ref>{{cite web|author=Johnson, Tom|url=http://idratherbewriting.com/2011/12/19/what-tools-do-technical-writers-use/|title=What Tools Do Technical Writers Use|work=I'd Rather Be Writing|date=December 19, 2011|access-date=May 4, 2014}}</ref> In some cases, engineers may perform the technical writing for the project they are working on, but this rarely occurs in large organizations where products must be released or revised weekly. On the business side, marketing materials or press releases are usually written by writers trained in a marketing field and/or creative writing. However, a technical writer may be relied upon to provide editing and other input on any technical content an organization may produce.
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)