Whatchamacallit: Controlled Vocabularies for Technical Writers

Description

An everyday dilemma in technical communication: What do you call that “thing”? Whether you ask developers, marketing folks or users, you often get very different views.

Along with user interfaces, documentation helps all stakeholders align their mental model of a product. Terminology plays a key role, and a controlled vocabulary is an ace up the technical writer's sleeve.

Controlled vocabularies are basically lists of concepts and the relationships between them. Beyond consistent naming, they are about structuring, categorizing and retrieving content. For example, you can use a vocabulary as a basis for documentation plans, tables of content, a help site's navigation, search filters, or even to organize test cases.

In this talk, I will share ways to create and maintain various types of vocabularies, and explain what each type is useful for. You can start with a flat list of terms and expand it into a glossary, a thesaurus, a taxonomy, or even a full-fledge ontology.

  • Conference: Write the Docs EU
  • Year: 2015

About the speaker

Emilie Boillat
https://www.writethedocs.org/videos/eu/2015/whatchamacallit-controlled-vocabularies-for-technical-writers-eboillat/
www.writethedocs.org
crawl=CC-MAIN-2022-49
15523
application/http; msgtype=response
sha1:DBNQ64CR76FIAEZEMTSVFAHUCBQ7FKA5
<urn:uuid:81700afa-d14e-4ad7-9531-025a56eee483>
2022-12-08T22:03:51Z
104.17.32.82
application/xhtml+xml
sha1:M6LMTJYJ6HVYJDYYCDZFGOI7L6SPI47Z
<urn:uuid:0d3a0ad1-a0e0-4dab-9ec9-0d87d5fad0dd>
https://www.writethedocs.org/videos/eu/2015/whatchamacallit-controlled-vocabularies-for-technical-writers-eboillat/
response
<urn:uuid:f527d9d8-2495-495a-a303-7ecd17e03a5b>
isPartOf: CC-MAIN-2022-49
publisher: Common Crawl
description: Wide crawl of the web for November/December 2022
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-111
software: Apache Nutch 1.19 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.4-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/