Discover published sets by community

A Table of Contents (TOC) is a list, usually found on a page before the start of a written work, that displays all the parts of the work and where they are located. Technical documents include a TOC to guide readers through the material.

Business-to-Business (B2B) involves the exchange of products, services, or information between businesses, rather than between businesses and consumers. Technical writing often involves creating documents for B2B transactions.

User Experience (UX) pertains to a person's emotions and attitudes about using a particular product, system, or service. Technical writers strive to improve UX through clear and concise documentation.

A Content Management System (CMS) is a software application that supports the creation, management, and modification of digital content. Technical writers may use a CMS to publish and organize documentation.

A README file is a document that introduces and explains a project or software. It often includes important information like how to install, use, and contribute to the project.

An Application Programming Interface (API) is a set of protocols and tools for building software applications. In technical writing, it commonly refers to the documentation that helps developers understand how to use a given API.

Darwin Information Typing Architecture (DITA) is an XML-based architecture for authoring, producing, and delivering technical information. It allows writers to create reusable content more efficiently.

Hypertext Markup Language (HTML) is the standard markup language for creating web pages and web applications. Technical writers often use HTML to write and format their online documentation.

Key Performance Indicator (KPI) is a measurable value that demonstrates how effectively a company is achieving key business objectives. In technical writing, KPIs can measure the success of documentation or user assistance materials.

User Acceptance Testing (UAT) is the final phase of the software testing process during which actual software users test the software to ensure it can handle required tasks in real-world scenarios. Technical writers often create UAT documentation.

Minimum Viable Product (MVP) is a development technique in which a new product is developed with sufficient features to satisfy early adopters. Technical writers create documentation for MVPs that explains the basic functionalities.

Quality Assurance (QA) involves the systematic process of determining whether a product or service meets specified requirements. Technical writers ensure their documents are of high quality and meet QA standards.

A Subject Matter Expert (SME) is a person with special knowledge or skills in a particular area of endeavor. Technical writers frequently consult SMEs to ensure the accuracy of their content.

Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. Technical writers may use XML to create structured documents.

Version control is a system that records changes to a file or set of files over time so that you can recall specific versions later. Technical writers use version control to manage documentation revisions.

Search Engine Optimization (SEO) is the practice of increasing the quantity and quality of traffic to a website through organic search engine results. Technical writing incorporates SEO to improve the visibility of online documentation.

Frequently Asked Questions (FAQ) are common questions and answers pertaining to a particular topic. Technical writers often compile FAQs to help users understand and troubleshoot products or services.

The Institute of Electrical and Electronics Engineers (IEEE) is a professional association for electronic engineering and electrical engineering. Technical writing in this field may adhere to IEEE standards.

A Graphical User Interface (GUI) is a type of user interface that allows users to interact with electronic devices with graphical icons and visual indicators. Technical writers might document GUI navigation and usage.