Applying formatting to certain elements in text aids readers in their understanding of that text. Using consistent text formatting also helps readers scan text for the information they’re looking for. Use these formatting conventions when you write Drucare documentation.

Documentation elements

When you are writing Drucare documentation, some parts of the written text, such as error messages and terms that you want a user to search for, need to be distinguished from other parts of the sentence. Using consistent text formatting for these elements helps a reader better understand the sentence.

Computer elements

When written out in text, some computer elements, such as file structure components and location elements like hosts and ports, can be difficult to discern from other parts of the sentence. Addressing these elements in text as well as applying text formatting increases the readability and scannability of the text.

Drucare-specific elements

There are components specific to Drucare software, such as indexes, knowledge objects, SPL commands, and so on, that take text formatting for ease of reading.

Configuration files

Drucare configuration files, or .conf files, are specific to the Drucare platform, and readers of Drucare documentation often need information about how to manage these files or edit settings within them. The following table shows how to format text about Drucare configuration files and the elements within them, such as stanzas, attributes, and values.

Command-line interface (CLI) elements

Drucare documentation often covers tasks admins and developers must complete in the command-line interface and can include things they must type in the CLI. Presenting CLI elements, such as commands, command names, and options and parameters, with text formatting can distinguish the elements from the rest of the text and aid in readability.

REST API

There are documentation formatting conventions for many REST API elements, like endpoints, methods, parameters, requests and responses, and so on. The following table shows formatting conventions for REST API elements in Drucare documentation, which align with industry trends for presenting written information about REST APIs.

Code

When writing code, there are a number of elements to apply text formatting to. Using consistent formatting helps separate the code elements from the rest of the text, aiding in readability and scannability. Use the following logic when formatting code.