Skip to main content
ShakewellContact

Reference

The Words This Industry Uses

Technical publications runs on acronyms, and most of them are defined nowhere a newcomer can reach. Each entry says what the term expands to, what it actually means on a program, and what it gets confused with.

65 terms

Jump To a Section

Grouped by where you meet them. Where a term has a longer piece behind it, the entry links through, because a definition is where a question starts rather than where it ends.

14 terms

S1000D and S-Series

ACT

ACT stands for Applicability Cross-reference Table.

The S1000D data module that declares the product attributes and conditions applicability expressions are allowed to test against.

Before content can say it applies only to certain aircraft, something has to define what attributes exist and what values they may take. The ACT is that declaration: the controlled vocabulary of the applicability system.

It sits alongside the CCT and PCT as the infrastructure modules that successful programs author first. Content written before the applicability vocabulary exists tends to invent its own, and reconciling those inventions later is a well-known way to spend a schedule.

Also written: applicability cross-reference table

Applicability

The machinery that records which content applies to which configuration, so one library can serve a fleet whose members are not identical.

No fleet is uniform. Serial ranges differ, modifications land on some tail numbers and not others, and operators configure the same platform differently. Applicability is how a structured library handles that as data rather than as a page of asterisks and footnotes.

Done well, a reader sees only what applies to the aircraft in front of them, and the system can prove why. Done badly, or done as free text, it becomes the most expensive kind of technical debt, because the errors it produces are exactly the errors that reach a technician working on the wrong configuration.

BREX

BREX stands for Business Rules EXchange.

The data module that encodes a project's S1000D business rules in machine-checkable form, so conformance can be validated rather than reviewed by eye.

S1000D leaves a great deal to the project, and the BREX is where those decisions stop being prose and become enforceable. It expresses the rules as checks a validator can run: which elements are permitted, which attribute values are legal, what must be present for a module to be acceptable.

A program without a working BREX is running on convention and goodwill, and it discovers its inconsistencies at delivery review. A program with one discovers them at authoring time, when they cost almost nothing to fix. It is the single highest-leverage artifact in an S1000D start-up, and it is routinely deferred.

Also written: BREX data module, business rules exchange

Business Rules

The decisions a program makes about everything its specification deliberately leaves open, from coding schemes to applicability to permitted content.

Specifications like S1000D define a framework and leave the choices to the project. Business rules are those choices written down: which standard numbering system to adopt, how difference codes are used, what an author may and may not do, how applicability is modeled, which information codes are in play.

They are an editorial act before they are a technical one, which is why they belong to the people who know the documents rather than to whoever configures the tool. Where the service has already made the decisions, as the U.S. Army has in MIL-STD-3031 and the Air Force in MIL-STD-3048, a program inherits much of its rules layer rather than writing it.

CIR

CIR stands for Common Information Repository.

S1000D data modules that hold shared definitions once, such as parts, tools, warnings and terms, so thousands of procedures reference one source.

A CIR centralizes the things many procedures refer to: part numbers, tools, consumables, warnings, and controlled terms. A procedure references the entry rather than restating it.

The payoff is that when a part number or a hazard wording changes, it changes in one place and every reference follows. The cost of skipping it is a library where the same warning is worded eleven ways and nobody can prove which version a technician actually read.

Also written: common information repository

CSDB

CSDB stands for Common Source Database.

The managed repository at the center of an S1000D program, holding every data module once and assembling publications from them on demand.

The CSDB holds the single authoritative copy of every data module, illustration, and publication module on a program, along with their status, versions, and relationships. Publications are assembled from it rather than stored in it, which is the whole point: one change to a module reaches every publication that references it.

It is more than storage. A CSDB manages the lifecycle of each object, enforces the program's business rules, tracks applicability, and provides the audit trail that answers which version of what was issued when. A folder structure with good naming conventions is not a CSDB, however disciplined the team maintaining it.

Also written: common source data base, common source database, S1000D CSDB

Data Module

The unit of content in S1000D: a self-contained piece of information, valid on its own, stored once in the CSDB and identified by a data module code.

A data module is one self-contained piece of information: a maintenance task, a description, a fault isolation procedure, a parts listing. It is authored once, stored once, and referenced by every publication that needs it.

Crucially, data modules are typed. A procedural module is not a descriptive module with different headings; each type carries its own schema and its own obligations about what it must contain. That typing is what allows a machine to validate whether content is complete, and it is the reason S1000D content survives tool changes that would destroy a word processor library.

DMC

DMC stands for Data Module Code.

The structured identifier that gives every S1000D data module a unique address encoding what it covers and what kind of information it holds.

A DMC is an address rather than a filename. Its segments encode the model the module belongs to, where the subject sits in the standard numbering system, which disassembly level and variant it concerns, and what kind of information it carries.

Because the address is structured, it is machine-readable: a system can select every procedural module for a given system without anyone maintaining a list. That is also why coding decisions made in the first weeks of a program echo for the life of the fleet, and why they belong in the business rules rather than in an individual author's habits.

Also written: data module code, DM code

DMRL

DMRL stands for Data Module Requirement List.

The planned inventory of every data module a project intends to produce, functioning as both the scope baseline and the progress tracker.

The DMRL lists what the program owes: every module, its type, and its status. It is the instrument that converts a vague deliverable into a countable one.

It is also the honest answer to estimating. Until a DMRL exists, an S1000D estimate is a guess, and once it exists, completion is arithmetic rather than opinion. Programs that treat it as a planning artifact rather than a living record lose that benefit almost immediately.

Also written: data module requirement list

Publication Module

The S1000D object that defines a deliverable publication as an ordered assembly of references to data modules, rather than as a document.

A publication module is a table of contents with authority. It names which data modules make up a given manual and in what order, so the manual itself is generated rather than maintained. Nothing is duplicated into it.

This is what makes the same content serve several deliverables at once. A procedure written once can appear in an operator manual, a maintenance manual, and a training publication, each assembled by its own publication module, each staying current automatically when the underlying module is revised.

Also written: PM, pub module

S1000D

International specification for technical publications using a common source database

The international specification for producing technical publications from a common source database, used across aerospace, defense, land and sea programs.

S1000D is not a file format and not a piece of software. It is a specification describing how technical information is broken into discrete, reusable data modules, how each one is identified and addressed, and how they are stored and assembled from a common source database.

Two things make it different from a general documentation standard. It is normally arrived at by contract rather than chosen, so the issue you work to is set by an acquisition authority. And it deliberately leaves a great deal open, which the program closes through its business rules layer. Two conformant S1000D programs can look almost nothing alike, and that is by design rather than by failure.

Also written: ASD S1000D, AECMA S1000D, S 1000D

S2000M

International specification for materiel management

The S-Series specification for materiel management: provisioning, spares data, and the source data behind illustrated parts catalogs.

S2000M governs the movement of materiel information between manufacturers, suppliers and operators: what parts exist, how they are provisioned, ordered, and supported through life.

Its relevance to publications is direct and frequently missed. The quality of an illustrated parts catalog is decided upstream in the provisioning data. By the time it reaches the publication it is too late to fix cheaply, which is why parts data and narrative content belong in the same plan.

S3000L

International procedure specification for Logistic Support Analysis

The S-Series specification for Logistic Support Analysis, the upstream process whose data drives publications, provisioning and training.

S3000L defines how the support requirements of a product are analyzed: what tasks are needed, at what interval, with what resources, skills and spares.

Publications sit downstream of it. On a connected program, the analysis and the maintenance manual share a source, so an interval change flows into the publication rather than being retyped into it. On a disconnected one, the two drift, and the manual eventually describes a maintenance program nobody is following.

Also written: LSA, logistic support analysis

SNS

SNS stands for Standard Numbering System.

The breakdown that assigns every system and component on a product a number, forming the subject portion of every data module code.

The SNS is how a product is divided up for documentation purposes, and it becomes part of the address of every module written against it. S1000D publishes example systems for various product types, and civil aviation programs often build on the same chapter logic as the ATA chapters.

Choosing an SNS is one of the earliest and least reversible decisions on a program. Change it later and every data module code changes with it, along with every cross-reference, which is why it is a business rules decision made deliberately rather than a default accepted quietly.

Also written: standard numbering system

17 terms

Defense and MIL-STD

CDRL

CDRL stands for Contract Data Requirements List.

The list of data deliverables a government contract requires, each line naming what is delivered, when, in what format, and to what standard.

Each CDRL line item points at a data item description and sets the delivery terms. Collectively they are the answer to what a program actually owes in data, which is a question surprisingly few programs can answer quickly.

For publications teams the CDRL is where scope hides. A single line can oblige a format, a review cycle, a delivery medium, and an acceptance process, and the cumulative weight of those obligations is rarely priced as carefully as the writing itself.

Also written: contract data requirements list, DD Form 1423

Data Rights

What the government may do with technical data it receives, split into unlimited, government purpose, limited and restricted categories.

Which category attaches to a deliverable decides whether the government can hand it to your competitor. Unlimited rights means exactly that; limited rights protects data developed exclusively at private expense; government purpose rights sits between them and historically converts to unlimited after five years.

The timing trap is that markings are a pre-award discipline. Missing the window to assert and mark proprietary data can forfeit the protection permanently, and no amount of careful delivery afterwards recovers it.

Also written: technical data rights, government purpose rights, limited rights

DID

DID stands for Data Item Description.

The standard document that defines the content and format required for a specific data deliverable cited on a CDRL line.

A CDRL line says what is owed and when. The DID it references says what the thing has to contain. Together with the cited standard and the statement of work, they form the citation chain that defines a deliverable.

When those sources disagree, and they do, the contract's order of precedence clause decides which wins. Knowing that clause exists, and what it says, is worth more than any amount of familiarity with the individual documents.

Also written: data item description

See also CDRL, TMCR, TDP

Distribution Statement

The marking on a DoD technical document, lettered A through F, declaring who may receive it and under what conditions.

Every DoD technical document carries one of six statements. They are access control rather than classification: a document can be entirely unclassified and still be restricted to specific audiences.

They matter operationally because they govern what your delivery system must be able to prove. A platform that cannot scope access per person and evidence who received which revision cannot honor the marking, whatever the cover page says.

Also written: distribution statement A, distribution D, distribution statements

FOSI

FOSI stands for Formatting Output Specification Instance.

A formatting specification used with SGML and military publishing, describing how tagged content should be presented in the output.

A FOSI separates presentation from content in the SGML world, in roughly the role a stylesheet plays elsewhere. Defense programs still encounter them because defense libraries still contain SGML.

Practically, a FOSI is often the reason a deliverable that validates correctly still looks wrong. Format conformance and content conformance are separate tests, and programs that assume one implies the other find out late.

Also written: formatting output specification instance

IADS

IADS stands for Interactive Authoring and Display Software.

The U.S. Army's government-furnished IETM authoring and viewing software, developed at Redstone Arsenal and specified across Army contracts.

IADS is software rather than a specification, which is the single most common misunderstanding about it. MIL-STD-40051 defines how Army technical manual content is structured; IADS is the government-provided environment that authors and displays it.

It matters commercially because the Army consolidated on it, retiring other electronic maintenance viewers, so a contract naming IADS is naming the standing destination rather than expressing a preference. Content that validates cleanly can still fail acceptance by behaving badly in the viewer, which is why testing in it belongs in the schedule from the first module.

Also written: IADS viewer, IADS4, IADS5

IETM

IETM stands for Interactive Electronic Technical Manual.

A technical manual designed to be used on a screen, with navigation, search, applicability filtering and interactive behavior rather than pages.

An IETM is not a PDF on a tablet. The distinction is that its content is data rather than pages, so the system can filter by configuration, follow a fault isolation path, resolve a reference, and record what was shown.

A legacy class scale from Class I, meaning electronically indexed page images, up through Class V, meaning integrated diagnostics, still circulates and contracts still cite it. It is worth knowing what a class citation means, and worth more to ask what the deliverable is actually expected to do.

Also written: interactive electronic technical manual, IETMs

IETP

IETP stands for Interactive Electronic Technical Publication.

The same category of deliverable as an IETM, under the name S1000D and several services prefer. Shaped per program by business rules.

IETP and IETM describe the same kind of thing: technical information delivered interactively rather than as pages. Which term a document uses tells you more about its lineage than about the deliverable.

What actually differs between two IETPs is not the acronym but the business rules: which functionality is required, which viewer it must run in, and what the acceptance criteria are. Those are contract facts worth pinning down early, because the word itself will not settle them.

Also written: interactive electronic technical publication

ITAR

ITAR stands for International Traffic in Arms Regulations.

The U.S. regulations controlling defense articles and the technical data about them, whose definition of technical data reads like a tech pubs library.

The ITAR's definition of technical data covers information required for the design, production, operation, repair and maintenance of defense articles, which describes the contents of a technical publications library almost exactly.

The consequence people underestimate is that providing controlled technical data to a foreign person can constitute an export without anything crossing a border. That makes per-person access control, and the evidence that it worked, the whole compliance story.

Also written: international traffic in arms regulations

LSA

LSA stands for Logistic Support Analysis.

The design-stage analysis of what a product will need in service (tasks, parts, tools, skills), recorded as data that feeds provisioning and manuals.

LSA was standardized by MIL-STD-1388-1A (the process) and MIL-STD-1388-2B (the record, or LSAR, keyed by LSA control numbers). Both were canceled in the 1990s; the data role passed to GEIA-STD-0007, and the S-Series carries the discipline in S3000L.

Its task analysis is the source of a manual's procedures and its provisioning data the source of its parts lists, so publications that drift from the analysis are wrong in ways only a maintainer notices.

Also written: logistics support analysis, LSAR, logistic support analysis record

MIL-STD-3031

The U.S. Army's S1000D business rules standard. Revision B (2024, with Change 1 in 2025) is current and aligns to S1000D Issue 4.2 rather than the newest issue.

Where an Army program runs S1000D rather than 40051, MIL-STD-3031 supplies the business rules layer: the decisions the specification leaves open, already made at service level.

The alignment lag is the detail that surprises people. A service rules standard points at a specific S1000D issue, and that issue is usually several behind the newest. It is the reason a new S1000D release does not reach most programs for years.

Also written: MIL STD 3031, 3031

MIL-STD-3048

The U.S. Air Force's S1000D business rules standard for Technical Orders. Revision C is current and aligns to S1000D Issue 4.1.

3048 does for Air Force Technical Orders what MIL-STD-3031 does for the Army: it settles the choices S1000D deliberately leaves open, at service level rather than program level.

Like its Army counterpart it aligns to an older S1000D issue, and like its Army counterpart that alignment moves on the standard's own revision cycle rather than the specification's.

Also written: MIL STD 3048, 3048

MIL-STD-38784

The DoD standard practice for the general style and format of technical manuals, currently at Revision C, issued in September 2024 and free from ASSIST.

38784 does not define a manual's technical content; the detail specification cited for each manual type does that. It defines the presentation layer those manuals share: style, format, the handling of changes, and the conventions readers rely on across documents.

Its warning, caution and note conventions are worth knowing precisely, because they differ from the ANSI Z535.6 conventions that govern commercial product manuals. A team writing for both markets is running two rule sets that share a vocabulary.

Also written: MIL STD 38784, 38784

MIL-STD-40051

The U.S. Army standard governing the content and structure of technical manuals, split into an IETM part and a page-based part, both at Revision D.

40051 is the Army's governing standard for technical manual content: work packages, required structure, and the rules a manual must satisfy to be acceptable. Part 1 covers interactive electronic delivery and Part 2 covers page-based manuals.

It is free to download from ASSIST, the Defense Logistics Agency's repository of record. Contracts still routinely cite superseded revisions, so the revision named in your TMCR matters more than the current one, and checking which is which is a five minute job that prevents a very expensive misunderstanding.

Also written: MIL STD 40051, MILSTD40051, 40051

RPSTL

RPSTL stands for Repair Parts and Special Tools List.

The parts and tools listing in a U.S. military technical manual, identifying every replaceable item and the tools needed to work on it.

The RPSTL is the military counterpart of a civil illustrated parts catalog: what the item is made of, how the pieces relate, and what is needed to service them.

It is a recurring conversion trap. Parts data usually lives apart from narrative content, maintained on its own schedule by a different team, and gets remembered at integration rather than at planning. Legacy RPSTL files frequently need converting before they will work in a target viewer.

Also written: repair parts and special tools list

TDP

TDP stands for Technical Data Package.

The complete technical description of an item sufficient to support procurement, production and sustainment, from drawings and models to specifications.

A TDP is what the government buys when it wants the ability to have something made or maintained by someone other than the original manufacturer. Its completeness determines whether that ability is real.

The modern version increasingly centers on the model rather than the drawing, which shifts the authoritative record upstream and makes the relationship between engineering data and publications considerably more direct.

Also written: technical data package

TMCR

TMCR stands for Technical Manual Contract Requirements.

The document that states exactly which technical manual standards a contract invokes and how each one is tailored for that program.

A TMCR is where the general becomes specific. It names the standards, the revisions, the parts that apply, what is tailored out, and what the program must deliver and verify. Two contracts citing the same standard can demand very different things once their TMCRs are read.

It is the single most under-read document in a technical publications bid. Pricing a proposal from the standard's name rather than the TMCR's tailoring is the most reliable way to discover the real scope after the price is fixed.

Also written: technical manual contract requirements

11 terms

Civil Aviation

Airworthiness Directive

A mandatory instruction from a regulator addressing an unsafe condition, which removes the operator's discretion about whether to comply.

Where a service bulletin is the manufacturer's recommendation, an airworthiness directive is the regulator's requirement. Compliance is not optional and is recorded.

For publications that means the documentation has to support proving compliance, not merely describing the task, which puts the burden on revision currency and on evidence of who was served what.

Also written: AD, airworthiness directives

AMM

AMM stands for Aircraft Maintenance Manual.

The airframer's manual for maintenance performed on the aircraft, covering fault isolation, removal, installation and scheduled tasks.

The AMM is published by whoever built the aircraft and governs work done on it. For a component, that usually means isolating a fault, removing the unit, and fitting a serviceable one.

It stops there deliberately. What happens to the removed unit belongs to the component vendor's manual, because the airframer neither designed it nor approves its repair.

Also written: aircraft maintenance manual

ATA Chapter

The numbering scheme that divides an aircraft into standard systems, so the same subject sits at the same number across manufacturers.

ATA chapters give the industry a shared address space: chapter 32 is landing gear whoever built the aircraft. That consistency is why a technician moving between types can still find things.

The scheme predates the digital specifications built on it and survives inside them, including as the basis for standard numbering in civil S1000D programs.

Also written: ATA chapters, ATA 100, ATA chapter list

ATA iSpec 2200

The civil aviation information standard for maintenance documentation, organized by the ATA chapter numbering the industry has used for decades.

iSpec 2200 governs the content and structure of commercial aircraft maintenance documentation: maintenance manuals, illustrated parts catalogs, wiring data and service bulletins.

Its unit of content is the publication rather than the module, which is the clearest structural difference from S1000D. Most fleets live between the two specifications for years, with newer types arriving in S1000D while the existing library stays where it is.

Also written: iSpec 2200, ATA Spec 2200, ATA 2200

CMM

CMM stands for Component Maintenance Manual.

The component vendor's manual for testing, repairing and overhauling a unit away from the aircraft, in a workshop.

A CMM covers what the AMM does not: disassembly, inspection against limits, the repairs that are approved, reassembly and test. It is published by the company that made the component.

For a repair station it is a regulatory artifact as much as a technical one, because capability is tied to holding current data for the components it is approved to work.

Also written: component maintenance manual, vendor manual

EFB

EFB stands for Electronic Flight Bag.

The device, usually a tablet, that carries the flight operations library, charts and performance tools into the cockpit.

The EFB replaced the paper flight bag, and with it the assumption that a crew's documents are static between revisions. Content reaches it on a schedule, and what is on the device at departure is what the crew will use.

That makes delivery and revision currency an operational matter rather than an administrative one: everything the crew needs has to be aboard, current, and provably so, before pushback.

Also written: electronic flight bag

FCOM

FCOM stands for Flight Crew Operating Manual.

The manufacturer's operating manual for the flight crew, describing systems, limitations and procedures for normal and non-normal operations.

The FCOM is the reference the crew works from, tailored by the operator within the limits the manufacturer and the approved flight manual allow.

It sits in a hierarchy: where the approved flight manual and the FCOM appear to disagree, the flight manual wins, which is why FCOM revisions are checked against it rather than issued independently.

Also written: flight crew operating manual

IPC

IPC stands for Illustrated Parts Catalog.

The catalog identifying every replaceable part on a product and its relationship to the assembly, used to order the right item.

An IPC links exploded illustrations to part numbers so that a person looking at hardware can identify what they need. Its usefulness depends entirely on the accuracy of the relationship between the picture and the data.

Its quality is decided upstream in provisioning rather than in publishing. A parts list that disagrees with the part actually fitted sends the wrong item across the world before anyone notices.

Also written: illustrated parts catalog, illustrated parts catalogue

MEL

MEL stands for Minimum Equipment List.

The list defining what may be inoperative and still permit dispatch, derived by each operator from the manufacturer's master list and approved.

The manufacturer publishes a master minimum equipment list. Each operator derives its own MEL from it, as restrictive or more, adapted to its routes, fleet and procedures, and gets that approved for its operation.

Crews dispatch against the operator's MEL, so the version in front of them has to be the approved current one. It is a document whose correctness is checked at the moment of use, every time.

Also written: minimum equipment list, MMEL

QRH

QRH stands for Quick Reference Handbook.

The time-critical extract of abnormal and emergency checklists, condensed for use in the seat while the event is happening.

The QRH is derived from the FCOM and revised in step with it. Its design constraint is that it will be read under the worst conditions the operation produces.

A QRH out of step with its FCOM is not a documentation defect; it is an operational hazard, which is the clearest illustration of why derived documents need a managed relationship to their source rather than a copy of it.

Also written: quick reference handbook

Service Bulletin

A manufacturer's notice of a modification or inspection, which the operator records as incorporated or not, making it configuration data.

A service bulletin tells operators about a change the manufacturer recommends or requires. Whether it has been incorporated on a given aircraft is a fact about that aircraft, not about the fleet.

Documentation has to reflect it both ways, showing post-incorporation content for modified aircraft and pre-incorporation content for the rest, which is exactly the effectivity problem structured content exists to solve.

Also written: SB, service bulletins

17 terms

Markup and Content

CCMS

CCMS stands for Component Content Management System.

A system that manages content as components rather than documents, tracking each piece, its versions, its relationships and where it is used.

A CCMS stores content at the component level: a topic, a warning, a procedure, a table. Each is managed on its own, with its own version history and its own record of every publication that uses it.

That last part is what distinguishes it from a document repository. When a component changes, the system knows what it affects. An S1000D CSDB is a CCMS specialized for that specification, where the components are data modules and the rules come from the BREX.

Also written: component content management system, ccms meaning, ccms full form

CGM

CGM stands for Computer Graphics Metafile.

The vector graphics standard technical illustration standardized on decades before SVG, still carrying hotspot data in aerospace libraries.

CGM stores illustrations as vectors rather than pixels, so they scale without degrading. WebCGM added the interactive layer that made it indispensable to IETMs: regions of an illustration can be hotspots that navigate somewhere.

That hotspot data is the reason flattening a CGM library to raster for convenience is destructive. It discards the interactivity a program is usually contracted to deliver.

Also written: cgm file, .cgm file, computer graphics metafile, WebCGM

CMS

CMS stands for Content Management System.

A system for managing content as pages or documents, typically for a website, rather than as reusable components.

A conventional CMS manages whole items: a page, a post, a file. That is exactly right for a website and wrong for a technical library, where the same procedure has to appear in six deliverables and stay identical in all of them.

The common failure is asking a marketing CMS and its media library to do a document management job. They were built for different problems, and the seams show at about the point the library reaches a few thousand controlled documents.

Also written: content management system

Content Model

The declared structure content must follow, expressed so a machine can enforce it, as opposed to a template that merely suggests a shape.

A content model says what a piece of content is made of and in what order: a procedure has preliminary requirements, then steps, and a step may carry a warning. It is enforceable.

This is the distinction from a template. A template describes how something should look and relies on people to comply. A content model refuses content that does not conform, which is why 'we have a template' and 'we have a content model' describe very different levels of control.

DAM

DAM stands for Digital Asset Management.

A system for storing and finding media assets such as images and video, optimized for retrieval and rights rather than document control.

A DAM is built for assets: find the right image, know its rights and formats, deliver it at the needed size. It is genuinely good at that.

It is not built to be the authority on which revision of a controlled procedure is in force, which is the job it gets asked to do when a marketing system is the only repository an organization has.

Also written: digital asset management

See also DMS, CCMS, CMS

Digital Thread

The connected chain of authoritative data across a product's life, from design through sustainment, with publications as its last mile.

The digital thread is the ambition that data flows rather than being retyped: a design change propagates into analysis, into support planning, and eventually into the manual a technician reads.

Publications are where the thread either arrives or breaks. A program can have excellent model-based engineering upstream and still hand a maintainer a PDF that nobody can trace back to anything.

See also MBD, TDP, S3000L

DITA

DITA stands for Darwin Information Typing Architecture.

An open XML architecture for topic-based technical content, built around typed topics, maps that assemble them, and specialization.

DITA organizes content as topics rather than documents, with maps defining which topics make up a deliverable and in what order. Conditional processing lets one source serve many variants.

Its distinguishing feature is specialization: a disciplined way to derive your own element types from the standard ones without breaking compatibility with generic tooling. DITA is adopted by choice, where S1000D is usually arrived at by contract, and that difference governs almost everything downstream including who decides when to migrate.

Also written: DITA XML, dita xml full form

DMS

DMS stands for Document Management System.

A system managing whole documents as controlled objects, with versions, approvals, permissions and an audit trail of who received what.

A DMS treats the document as the unit and concerns itself with control: which version is current, who approved it, who may see it, and what the record says about distribution.

It is a different job from a CCMS, which manages the pieces content is made from. Regulated organizations frequently need both, and confusing the two produces either a library nobody can prove anything about or a component system nobody can release from.

Also written: document management system

DTD

DTD stands for Document Type Definition.

The older grammar mechanism declaring which elements and attributes a document may contain, inherited from SGML and still cited by contracts.

A DTD declares the vocabulary and structure a conformant document must follow. It is not namespace-aware and has no concept of data types, so it can require that a value be present but not that it be a date.

It persists because contracts cite it. A 40051 program means DTDs in practice, whatever the tooling would prefer.

Also written: document type definition

MBD

MBD stands for Model-Based Definition.

The approach where an annotated 3D model, rather than a drawing, is the authoritative definition of a product and the source downstream data derives from.

In an MBD approach the model carries the dimensions, tolerances and annotations that a drawing used to carry, and it becomes the record other activities work from rather than a picture generated alongside one.

For publications this changes where content comes from. When the model is authoritative, illustrations and procedures can derive from it rather than being redrawn, and the relationship between engineering change and documentation change becomes direct instead of manual.

Also written: model-based definition, model based definition, model-based enterprise

Schematron

A rule-based validation language that checks relationships and project policy a schema cannot express, such as cross-element conditions.

A schema checks shape. Schematron checks meaning: if this module is procedural, a warning must precede the step it concerns; if this code is used, that attribute is mandatory.

In S1000D terms this is the natural home of business-rule checking layered on top of the delivered schemas, which is exactly the role the BREX plays.

SGML

SGML stands for Standard Generalized Markup Language.

The markup framework that taught aerospace and defense to structure documents, and the ancestor XML simplified and replaced.

SGML was a framework for defining markup languages rather than a language itself, and defense and aerospace produced decades of technical manuals under standards built on it.

Those libraries still exist and still have to be read, revised and eventually converted. They are also the best-behaved legacy content there is, because they were validated against a grammar when they were written.

Also written: standard generalized markup language, standard generalized markup language

Single-Sourcing

Writing content once and generating every deliverable from it, so a change made in one place reaches every output that uses it.

Single-sourcing is the practice the whole structured content apparatus exists to enable: one authored source, many renditions, nothing re-keyed and nothing left to drift.

The promise is only as real as the machinery behind it. Content copied between deliverables to save time reintroduces exactly the divergence the approach was adopted to prevent, and it does so invisibly.

Also written: single source of truth, single source publishing

SVG

SVG stands for Scalable Vector Graphics.

The web-native vector graphics format, XML-based and increasingly the technical illustration format of choice alongside or instead of CGM.

SVG is vector graphics expressed as XML, which means illustrations can be inspected, validated and transformed with the same tools as the content around them.

S1000D Issue 6 introduced an SVG profile for technical illustration, which is the clearest signal of direction: new work increasingly starts in SVG while substantial CGM libraries remain in service.

Also written: scalable vector graphics

See also CGM, XML, IETM

Topic

A standalone unit of content about a single subject, written to be understood without the surrounding document and reused in many.

Topic-based authoring means writing pieces that make sense on their own, rather than chapters that depend on what came before them. It is the precondition for reuse: content that assumes context cannot be moved.

The discipline is editorial rather than technical. Tools can enforce that a topic exists; only a writer can ensure it does not begin with the word 'therefore'.

XML

Extensible Markup Language

The markup format underneath most modern documentation standards, where structure is explicit and can be validated against a schema.

XML makes structure explicit and checkable. A heading is tagged as a heading, a warning as a warning, and a machine can verify that a document contains what it is required to contain.

That is why technical publications standards are built on it. When a manual outlives the software that wrote it, which in defense is routine, a vendor-neutral validated format is the only thing that survives the transition.

Also written: extensible markup language

See also SGML, XSD, DTD, DITA

XSD

XSD stands for XML Schema Definition.

The modern schema language: written in XML itself, namespace-aware, and able to declare that a value must be a date or a bounded number.

XSD fixed what DTDs could not do. It is typed, so an attribute can be declared a date, an integer within bounds, or a string matching a pattern, and validation catches errors a DTD would pass.

Grammar, types and rules are three separate layers of enforcement. A schema says what may appear; something like Schematron says what your project actually permits.

Also written: XML Schema, xml schema definition

See also DTD, XML, Schematron, BREX

6 terms

Language and Terminology

ASD-STE100

Simplified Technical English

The controlled language specification for technical documentation: about sixty-five writing rules plus a dictionary where each word has one meaning.

STE constrains vocabulary and sentence construction so that documentation is unambiguous for readers working in a second language, under time pressure, in poor conditions. Approved words carry one meaning and one part of speech.

It does not constrain technical precision. Technical names and technical verbs specific to a product remain available. The current issue is Issue 9, published in January 2025, and the specification is issued free of charge on request.

Also written: STE, simplified technical english, ASD STE100, ste100

Controlled Language

A deliberately restricted subset of a natural language, limiting vocabulary and grammar so meaning is consistent and machine-tractable.

Controlled language trades expressive range for predictability. The same idea is always written the same way, which reduces ambiguity for readers and variance for translators.

An unplanned beneficiary is machine reading. Content where one concept has one name and one sentence carries one instruction is content a retrieval system can ground on reliably, which was not the reason anyone adopted it.

Defined Term

A word or phrase given a stipulated meaning for the purposes of a document, binding wherever it appears and managed rather than retyped.

In regulated documents a defined term is not decoration. It carries a specific meaning assigned in a definitions section, and every use of it inherits that meaning.

Managing them as content rather than convention is what keeps a library honest. When the definition changes, every reference should follow, and a system that links uses to the definition makes that automatic rather than aspirational.

Metadata

The structured data about a piece of content: what it is, what it applies to, its status and version, used to manage and assemble it.

Metadata is what lets a system act on content without reading it: select every procedural module for a system, find everything affected by a part number change, serve only what applies to a configuration.

It stops being an editorial nicety the moment content is consumed by machines as well as people. A library a model grounds on is only as good as the structure and metadata describing it.

Taxonomy

The controlled structure of categories and terms used to classify content, so it can be filtered, found and assembled consistently.

A taxonomy is the agreed set of buckets and labels content is tagged with. It is what makes filtering by product, audience, or configuration possible without anyone maintaining a list by hand.

It is also where sprawl does the most damage. Letting the vocabulary grow to accommodate every request produces a scheme too large to apply consistently, at which point the tags stop meaning anything.

Warning, Caution, Note

The signal words that flag safety content, whose definitions differ between ANSI Z535.6 and DoD manual conventions in a way that catches teams out.

Under ANSI Z535.6, DANGER, WARNING and CAUTION all concern injury to a person and differ only in severity, while NOTICE covers property damage. In DoD technical manuals the long-standing convention is different: WARNING for personnel, CAUTION for equipment, NOTE for emphasis.

So CAUTION means people in one rule book and equipment in the other. A team writing for both markets is running two conventions that share a vocabulary, and the failure mode is applying the right rule from the wrong standard.

Also written: warnings and cautions, ANSI Z535.6, signal words

Get In Touch

Working Out What Your Contract Actually Wants?

Knowing the vocabulary is the easy half. If you need to know what a citation obligates on your program, that is the conversation we are built for.