Docs Menu

Docs HomeMongoDB Meta Documentation

MongoDB Documentation Style Guide

This document contains writing, style, terminology, and image guidelines for MongoDB technical documentation. Use these guidelines to create clear, concise, and consistent technical content for MongoDB external and internal customers.

Writing Guidelines
Provides detailed advice for writing content that is clear, active, direct, and grammatically correct. This section explains fundamental standards for good technical writing.
Style Guidelines
Provides information about how certain elements appear in MongoDB content. For example, how we show abbreviations, how we capitalize headings, whether we allow contractions, and what formatting we apply to certain text.
Terminology Guidelines
Provides advice for using accurate, consistent, and concise terminology in your content, and for writing for a global audience.
Markup Guidelines
Provides detailed guidelines about and instructions for applying reStructuredText (RST) and Yet Another Markup Language (YAML).
Screenshot and Diagram Guidelines
Provides instructions for when to use and how to create screenshots and diagrams to enhance your content.
Release Notes Guidelines
Provides instructions specifically for writing release notes for MongoDB products. You can use these basic guidelines, however, when writing release notes for any product or service.
Information Types
Provides guidelines for information types to identify the goals of a page and its audience.
Search Engine Optimization Guidelines
Provides guidance for optimizing your documentation pages for search.
User Interface Guidelines
Provides specifications for the user interface of MongoDB web and desktop applications. The components can be viewed online

The MongoDB Style Guide includes material from the following:

←  The MongoDB Documentation ProjectQuickstart →