Ensure that you use punctuation correctly to create clear and unambiguous documentation.
- Using capitalization
To help user understand and identify the features that you describe, make capitalization consistent in all the texts that you create.
- Grammar guidelines
To create clear, consistent documentation that is understandable by all users, ensure that you adhere to the following grammar guidelines:
Use a comma to separate elements in a sentence, such as items in a series, introductory phrases, or clauses. Apply the following specific rules for correct comma usage.
- Hyphens and dashes
Follow our style guidance to learn when to use hyphens in compounds and, in very specific cases, with prefixes, and when to apply en dashes in ranges. Do not use em dashes if you can replace them with other punctuation marks, such as commas, semicolons, or dedicated DITA elements (such as the dl tag).
The slash is a punctuation mark that is most often used to represent the conjunction and, or the inclusive form of or. It is also used in mathematics to show fractions and division, in computing to separate the parts of a URL, and in some languages as a date separator.
There are four kinds of bracket: round, curly, angle, and square. Parentheses are what we properly call round brackets.
- Quotation marks and apostrophes
As with the use of punctuation to create decimal points in numbers, the use of quotation marks and apostrophes can vary significantly from language to language. In our work as writers and editors at Pega, there are only a few short rules for their correct usage.