1. Home
  2. Docs
  3. Style Guide
  4. Notes, Tips, and Warnings

Notes, Tips, and Warnings

Notes, tips, and warnings are key elements in technical documentation, providing users with additional context, helpful suggestions, and important cautions. They help draw attention to critical information that might not be immediately obvious in the main text. To use these elements effectively, it is essential to format them correctly, place them strategically, and differentiate their purposes clearly. This section provides guidelines on formatting, when to use each type, and how to distinguish between tips and warnings.

Articles