Editing Technical writing (section)

==Technical documents==
[[File:2016 Instruction Manual.jpg|thumb|291x291px|Slimeline digital timer instruction manual from 2016. ]]
Technical writing covers many genres and writing styles, depending on the information and audience. Some examples of commonly used technical documentation include:
* '''API documentation''': Used exclusively in the web development field to document the operation and installation instructions for an [[application programming interface]]. API coding tools (e.g., Swagger, Postman, etc.) allow technical writers to easily produce documentation in ''[[markdown]] '' for upload to specific API directories containing related API code (e.g., localization API, login API, security API). API documentation is generally automatically converted into a standardized "[[markdown]]" format inside of an API tool's [[WYSIWYG]] editor. In most cases, programmers and technical writers upload code and content updates to a "[[Git]]" repository where a mirror image of a website is maintained. Programmers will then move the updated directories onto the live server once testing is complete. 
* '''Assembly Instructions (AI)''': Provides internal procedures for assembly-line personnel. Individual steps are written and assigned to members of an assembly team. Often the technical writer will include CAD explosions to simplify complex assemblies.
* '''[[Case study]]''': A published report about a person, group, or situation that has been studied over time; ''also'' a situation in real life that can be looked at or studied to learn about something.<ref>{{cite web |title=Dictionary and Thesaurus |url=https://www.merriam-webster.com/dictionary/case%20study |access-date=2016-01-22 |website=Merriam-Webster }}</ref> In large organizations, technical writers only provide copyediting or ghostwriting services for case studies. Management-level authorship is generally required to meet national standards and codes.
*'''Component Maintenance Manuals (CMMs)''': Mainly used in aerospace to notify customers whenever an entire component must be repaired or replaced. All component-related Service Bulletins must be incorporated and/or referenced in a CMM, along with the latest component drawings and information. CMMs follow Aerospace Transport Association (ATA) formatting and [[ATA Spec 100/iSpec 2200]] chaptering.
*'''Installation manuals (IM)''': Procedures designed to help the end-user install a product or software program in the field. 
*'''Inspection Report''': Mainly used in large building construction and civil engineering, this report details the construction issues/defects identified by a field inspector at various project stages. The identified issues/defects are captured, initially, in a [[Punch list]]. A technical writer references the Punch list to write an inspection report. Detailed issue/defect images, locations, and descriptions are provided in inspection reports so builders can more easily understand how best to fix issues or make repairs correctly. In some cases, suggested remedies may also be included. 
* '''Knowledgebase''' or '''Help center''': Online help sites, designed to provide users with pages of technical information about products and/or services. The content for these sites may be created and uploaded to the web in SGML, XML, or XHTML. Technical writing [[Content management system]]s are used to manage and upload these websites.
*'''[[Packing list]] or [[Shipping list]]''': Identifies the shipped parts, product safety data and manufacturer's contact information.
*'''Service Bulletins (SBs)''': Mainly used in aerospace, these manuals are for minor repairs and modifications. Manufacturers author and then issue SBs to aircraft owners when a modification or update to an individual part, within a component, may be necessary. SBs follow Aerospace Transport Association (ATA) formatting and [[ATA Spec 100/iSpec 2200]] chaptering.
* '''Specifications''' or '''Specs''': Used in the construction industry to outline installation minimum standards and requirements. Specifications are normally provided to the builder by a project manager and must be signed and accepted by the builder as part of the contract. Formatting standards are set by the [[Construction Specifications Institute| Construction Specifications Institute (CSI)]].
*'''Specification sheet'''/'''Spec Sheets''' or '''[[Datasheets]]''': One or two-page reference sheets, designed to provide common product/service characteristics required for specific applications. Common product/service maximum and minimum characteristics may include: size and footprint, weight, connection type or interfaces, electrical requirements, speed, etc.
*'''Standard Operating Procedures (SOPs)''': Procedural steps military, manufacturing, medical, and industrial safety personnel reference to accomplish assembly, processing, or any other work task that must be physically completed in proper order.
*'''Technical marketing content''': Information written exclusively for marketing purposes. This content is often used to help describe product information and specifications in marketing materials and on product/service web pages. Traditionally, creative writers specializing in marketing are hired for this work. 
*'''User Manuals (UM)''' or '''Operation manuals''': Procedural instructions for a product or program's operation. 
*'''[[White papers]]''': Marketing documents, often ghostwritten by technical writers and credited to experts in a field. All white papers have a persuasive subject and present an argument supporting the expert's conclusion.