Technical communication

Hypertext Markup Language (HTML) is the standard markup language for documents designed to be displayed in a web browser. It defines the content and structure of web content. It is often assisted by technologies such as Cascading Style Sheets (CSS) and scripting languages such as JavaScript.

Extensible Markup Language (XML) is a markup language and file format for storing, transmitting, and reconstructing data. It defines a set of rules for encoding documents in a format that is both human-readable and machine-readable. The World Wide Web Consortium's XML 1.0 Specification of 1998 and several other related specifications—all of them free open standards—define XML.

An application programming interface (API) is a connection between computers or between computer programs. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation.

thumb|In the 21st century, metadata typically refers to digital forms, but traditional card catalogs contain metadata, with cards holding information about books in a library (author, title, subject, etc.).

thumb|255px|A simple flowchart representing a process for dealing with a non-functioning Light fixture|lamp

authoritative report that provides information about a specific issue

The ORCID (; Open Researcher and Contributor ID) is a nonproprietary persistent identifier, in the form of an alphanumeric code, to uniquely identify authors and contributors of scholarly communication.

required norm or standard established to make it easier to do something in a consistent way

A/An FAQ is a curated list of questions and answers designed to address aspects of a topic that are important, often unknown or misunderstood. It is an acronym that expands to "frequently asked question" or "frequently asked questions". While either expansion implies that questions are often asked, they generally are not. FAQ is more about the question-answer format and an indication of the relevance of the content. Each question may be conglomerated from multiple real questions, what an author anticipates a reader will wonder about, or is simply a way of organizing information.

English-based controlled language

markup language

PostScript (PS) is a page description language and dynamically typed, stack-based programming language. It is most commonly used in the electronic publishing and desktop publishing realm, but as a Turing complete programming language, it can be used for many other purposes as well. PostScript was created at Adobe Systems by John Warnock, Charles Geschke, Doug Brotz, Ed Taft and Bill Paxton from 1982 to 1984. The most recent version, PostScript 3, was released in 1997.

information repository with multiple applications

process in which software is made accessible to people in different areas of the world

Usability or user-friendliness can be described as the capacity of a system to provide a condition for its users to perform the tasks safely, effectively, and efficiently while enjoying the experience. In software engineering, usability is the degree to which a software can be used by specified consumers to achieve quantified objectives with effectiveness, efficiency, and satisfaction in a quantified context of use.

activity of managing the versions of one or more files

specification of a conceptualization

Documentation is any communicable material that is used to describe, explain, or instruct regarding some attributes of an object, system, or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples of such resources include user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Contemporary documentation is often distributed through

literature on scientific topics

structural design of shared information

list of the parts of a book or document organized in the order in which the parts appear

document file format developed by Microsoft

specialized computer language used to describe the structure and behavior of electronic circuits, and most commonly, digital logic circuits

set of standards for the writing and design of documents

materials produced by organizations outside of traditional channels

specialization of design focused on the experience users have of a product or service

GameFAQs is a video gaming website that hosts guides and other resources, as well as an active message board forum. It was created in November 1995 by Jeff Veasey and has been owned by Fandom, Inc. since October 2022. Allen "SBAllen" Tyner was lead Admin for twenty years until stepping down on October 18, 2023. The site is currently run by Community Manager "DToast" and Contributor Lead "ZoopSoul".

technical communication document

alt=black and white mug with liquid inside|thumb|mug labelled 'RTFM'

process for maintaining consistency of a product attributes with its design

explicit implementation of requirements to be satisfied by a material, design, product, or service

DocBook is a semantic markup language for technical documentation. It was originally intended for writing technical documents related to computer hardware and software, but it can be used for any other sort of documentation.

framework of processes

process of managing information or experiences built with an audience in mind

help content, typically written text, that accompanies computer software and explains its functionality

knowledge organization system

writing or drafting technical communication used in technical and occupational fields

type of implicit long-term memory which aids the performance of particular types of tasks without conscious awareness of these previous experiences

work that an editor does to improve the formatting, style, and accuracy of text

professional information communicator

tentative government report of a proposal

online, searchable, encyclopedic dictionary of computing subjects

proprietary online help format, consisting of multiple HTML pages compressed into a binary file with the .chm extension

intelligent user interface for Microsoft Office that assisted users by way of an interactive animated character

Microlearning refers to a set of compact e-learning modules that are designed to reduce learner fatigue. The modules can be educational, professional, or skill-based, and are usually designed to be less than 20 minutes long, with a single learning objective or topic. The name originates from the Greek word 'micro' meaning 'small'.

thumb|upright=1.1|Front page of a floppy disk controller data sheet (1979)

standardized and organized sets of words and phrases for retrieval and disambiguation of information, distinguishing preferred terms from non-preferred terms

A changelog is a list of changes made to software that has been revised over time such as a codebase or a product.

controlled language developed to help users of maintenance documentation

translation of a document produced by technical writers

A schematic, or schematic diagram, is a designed representation of the elements of a system using abstract, graphic symbols rather than realistic pictures. A schematic usually omits all details that are not relevant to the key information the schematic is intended to convey, and may include oversimplified elements in order to make this essential meaning easier to grasp, as well as additional organization of the information.

fictional character created to represent the different user types within a targeted demographic

the study and/or practice of communicating technical information

ability to do something

document that describes the process, progress, or results of technical or scientific research or the state of a technical or scientific research problem

In scientific writing, IMRAD or IMRaD () (Introduction, Methods, Results, and Discussion) is a common organizational structure for the format of a document. IMRaD is the most prominent norm for the structure of a scientific journal article of the original research type.

presentation of data in a format which emphasizes key points concisely, usually using tables, bullet points and/or headings, on a single printed page

instructional book or booklet that is supplied with almost all technologically advanced consumer products

data model

field which studies the methods and methodologies for building ontologies, which are formal representations of a set of concepts within a domain and the relationships between those concepts