technical writing
Explaining complex information
Technical writing is communication designed to convey specialized information clearly and usably.
It includes manuals, documentation, specifications, and instructions—anything meant to help readers understand or perform tasks in a particular field.
Good technical writing prioritizes clarity over style: The technical writing for this software is actually readable.
Technical writers translate expert knowledge for specific audiences, whether engineers, end users, or regulators.
Written instructions for use
- user guideProduct instruction document
- handbookCompact reference guide
- specificationsStated requirements and parameters
- reference guideInformational consultation resource
how-to · tutorial · knowledge base · FAQ · troubleshooting guide · release notes · readme · style guide
Easily understood communication
- jargon-freeLacking technical language
- readableEasy to understand
- accessibleAble to be reached
- conciseBriefly and clearly stated
unambiguous · coherent · explicit · straightforward · comprehensible · scannable · digestible · user-friendly
Degree of correctness
- specificityExactness of detail
- exactnessCorrectness in every detail
- detailSingle small element
- rigorStrict, thorough precision
meticulousness · thoroughness · consistency · terminology · definitions · nomenclature · standardization · version control
Ultimate product recipient
- developerOne who builds things
- administratorPerson who manages operations
- beginnerOne who lacks experience
- expertHighly skilled practitioner
stakeholder · SME · subject matter expert · persona · localization · translation · internationalization · accessibility
In sequential stages
- procedurePrescribed sequence of actions
- walkthroughSequential instructional guide
- implementationPutting plans into effect
- configurationArrangement of parts
assembly instructions · workflow · task-based · sequential · prerequisites · warnings · cautions · notes
Structured data markup language
- MarkdownPlain-text formatting language
- ConfluenceEnterprise collaboration wiki platform
- GitDistributed version control system
- CMSWeb publishing platform
content management · reuse · templates · snippets · variables · version control
manual
Written instructions for use
- user guideProduct instruction document
- handbookCompact reference guide
- specificationsStated requirements and parameters
reference guide · how-to · tutorial · knowledge base · FAQ · troubleshooting guide · release notes · readme · style guide · datasheet
plain language
Easily understood communication
- jargon-freeLacking technical language
- readableEasy to understand
- accessibleAble to be reached
concise · unambiguous · coherent · explicit · straightforward · comprehensible · scannable · digestible · user-friendly · structured
accuracy
Degree of correctness
- specificityExactness of detail
- exactnessCorrectness in every detail
- detailSingle small element
rigor · meticulousness · thoroughness · consistency · terminology · definitions · nomenclature · standardization · version control · fact-checking
end user
Ultimate product recipient
- developerOne who builds things
- administratorPerson who manages operations
- beginnerOne who lacks experience
expert · stakeholder · SME · subject matter expert · persona · localization · translation · internationalization · accessibility · screen reader
step-by-step
In sequential stages
- procedurePrescribed sequence of actions
- walkthroughSequential instructional guide
- implementationPutting plans into effect
configuration · assembly instructions · workflow · task-based · sequential · prerequisites · warnings · cautions · notes · tips
XML
Structured data markup language
- MarkdownPlain-text formatting language
- ConfluenceEnterprise collaboration wiki platform
- GitDistributed version control system
CMS · content management · reuse · templates · snippets · variables · version control
- writingdrafting, authors, author, books, authoring
- freelance workghostwriting, graphic design, web design, illustrations, logos
- job skillsproblem-solving, teamwork, communication, time management, organization
- technical skillscoding, programming, data entry, debugging, software development
- Freelance Writingcopywriting, ghostwriting, blogging, editing, proofreading
- knowledge industrieseducation, consulting, academic research, research, data analytics
technical writingcreative writing
Original literary expression
creative prose · fiction · poetry · literary fiction · imaginative writing
technical writingfree verse
Poetry without fixed structure
stream of consciousness · avant-garde writing · freewriting · automatic writing
writing, technique, technical, technology, technician, technically, technologies, technological, nontechnical