Technical documentation is often a struggle to read. This document features some typographical conventions to help the reader understand the content, and to help distinguish explanatory text from dialog with the computer.
The descriptions in this User Guide include many technical terms, spanning two professional domains, that appear in boldface type. The first time a technical term is used on a page it is linked with a definition in one of two glossaries: The Astro Glossary covers astronomical terms and concepts, and the DMS Glossary covers terms used in software development as well as terms used to describe the DMS system components and function.
Names of software packages, including packages that were built by Data Management for the LSST Stack, appear in boldface type. Names of third-party packages are often linked to the web site from which they can be downloaded.
Code Blocks and Literals
When describing a process for using software, the text that should be typed by the user appears in a code block:
|title||Example code block|
echo "Hello, world!"
with fixed-space font and (often) syntax highlighting that is appropriate for the context. Text describing a literal command-line, names of arguments, directory and file names, etc. are set in