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!
==Tools== The following tools are used by technical writers to author and present documents: *'''[[3D rendering|CAD rendering]]''': Technical writers working in mechanical engineering often use CAD rendering tools to "explode" engineering-created and -approved 3D CAD designs. The goal is to visually communicate assembly/disassembly procedural steps more clearly. Specialized technical communication CAD software is normally used to modify existing CAD models. *'''[[List of collaborative software|Collaborative software programs.]]''' Technical writing requires collaboration between multiple parties from different departments within an organization.<ref name="Mike Markel 2012"/>{{rp|p=57}} To increase communication between parties, technical writers rely on [[Wiki|Wiki Systems]] such as [[Confluence (software)|Confluence]] and shared document workspacess.<ref name="Mike Markel 2012"/>{{rp|p=74}} *'''[[Content Management Systems]] (CMSs):''' Modern technical writing is edited and published in a specialized CMS or [[Component content management system|CCMS]] designed for technical writing. The CMS is used to easily and rapidly publish large volumes of technical writing content online. The uploaded content is automatically converted into a "knowledgebase" help system for end-users to reference. In addition to basic [[WYSIWYG]] editing features and web uploading, a CMS also provides content management features with version management and built-in tools to manage large documentation workflows. Most CMSs used for technical writing are [[SGML]], [[XML]], or [[XHTML]] based. *'''[[Desktop publishing|Desktop publishing tools]] or [[word processors]]''': In the 1990s, most technical writing was performed with word processing tools. These early programs allowed technical writers to author, edit, design, and print documents from a computer. White paper authors generally still rely on word processing and enhanced desktop publishing tools to edit their documents.<ref>Johnson, Tom [http://idratherbewriting.com/2011/12/19/what-tools-do-technical-writers-use/ "What Tools Do Technical Writers Use".] ''I'd Rather Be Writing''. December 19, 2011. Retrieved May 4, 2014.</ref> *'''[[Graphics software]]''': Images and other visual elements are used in technical writing to help communicate information in simpler terms than printed text can accomplish.<ref name="Mike Markel 2012"/>{{rp|pp=306β307}} In these instances, popularly used graphic software is used in technical writing to create and edit the visual elements of documents (e.g., photos, icons, diagrams, etc.) *'''Graphing software.''' To communicate statistical information, technical writing often includes graphs and flowcharts.<ref name="Mike Markel 2012"/>{{rp|pp=306β307}} Popular database software is commonly used to create basic graphs and charts. Occasionally, technical writing must provide more sophisticated graphs with interactive online features. SQL database graphing software is often used to perform this work.<ref>{{cite web|author=Hewitt, John|url=http://www.poewar.com/document-hack-a-technical-writers-journal-visio-meets-framemaker/|title=How Technical writers use Microsoft Visio|work=Poe War|date=January 18, 2005|access-date=May 9, 2014|url-status=dead|archive-url=https://web.archive.org/web/20140512235332/http://www.poewar.com/document-hack-a-technical-writers-journal-visio-meets-framemaker/|archive-date=May 12, 2014}}</ref> *'''Screen capture tools:''' Technical writing for software procedures frequently includes screen captures.<ref>{{cite report|author=Brierley, Sean|url=http://www.stc-carolina.org/wiki_attachments/Screen_Captures_102.pdf |title=Screen Captures 102|work=STC Carolina|year=2002|access-date=May 9, 2014|pages= 5β8}}</ref><ref>{{cite web|author=Johnson, Tom|date=December 19, 2011|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|access-date=May 4, 2014}}</ref> There are two types of screen capture - still frame and video. Still-frame screen captures are popularly used in the software industry. Technical writers often include a still-frame screen capture to help explain more complex procedures. Sometimes, a technical writer may simply record a short video of their desktops to show a software procedure. However, this is less common due to the many revisions software experiences. *'''Specification software:''' Cloud-based specifying software is often used by a "specifier/technical writer" to select a list of common minimum standards required for a construction project. These programs are normally formatted to comply with the [[Construction Specifications Institute|Construction Specifications Institute (CSI)]] standards.
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)