Skip to content

Commit 981e8a7

Browse files
committed
Add style guide
1 parent 14aa1f3 commit 981e8a7

4 files changed

Lines changed: 1632 additions & 0 deletions

File tree

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Mendix Documentation Style Guide"
3+
url: /community-tools/contribute-to-mendix-docs/style-guide/
4+
weight: 10
5+
description: "Comprehensive guidelines on terminology, grammar, formatting, inclusive language, document structuring, and image usage for Mendix documentation."
6+
---
7+
8+
## Introduction
9+
10+
The Documentation group maintains guidelines on terminology, grammar, formatting, inclusive language, document structuring, and image usage that are applied to the [Mendix Documentation](https://docs.mendix.com/) and the [Mendix Platform Evaluation Guide](https://www.mendix.com/evaluation-guide/).
11+
12+
The guidelines can be referenced in these sections:
13+
14+
* [Grammar & Formatting](grammar-formatting/)
15+
* [Terminology](terminology/)
16+
* [Inclusive Language](inclusive-language/)
17+
* [Structuring](structuring/)
18+
* [Images, Icons, and Videos](images-icons-videos/)
19+
* [Shortcodes, Markdown, and HTML](shortcodes-markdown-html/)
20+
* [Front Matter (Metadata)](front-matter/)
21+
* [Microcopy Guide](microcopy-guide/)
22+
* [Mendix Product Naming Guide](product-naming-guide/)
23+
24+
The tone of the Mendix documentation is conversational, relaxed, and always straight-forward. The tone reflects the Documentation group's values.
25+
26+
Our language conventions are based on American English.
27+
28+
When editing the Evaluation Guide, you can use the WordPress shortcodes described in <https://mendix.atlassian.net/wiki/x/vwB2vg>

0 commit comments

Comments
 (0)