Skip to content

Commit 52308d3

Browse files
authored
Clarify style guide rules for person, dates, and terminology (#11267)
* Update guidance * Specify first-person plural guidance for Claude
1 parent df0820f commit 52308d3

6 files changed

Lines changed: 24 additions & 13 deletions

File tree

.claude/skills/docs-polish/SKILL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Improve clarity and readability without changing meaning, structure, or paragrap
2020
* Simplify wordy or awkward phrasing
2121
* Improve word choice (more precise or accessible terms)
2222
* Change passive voice to active voice where appropriate
23-
* Remove bold and italics used for emphasis (reword or use alerts if needed)
23+
* Remove first-person plural (we, us, our, let's), except in release notes
24+
* Remove bold and italics used for emphasis (reword or use alert shortcodes if needed)
2425
* Apply Mendix style guide standards (overrides the Microsoft Writing Style Guide)
2526
* Apply Microsoft Writing Style Guide standards, unless they conflict with the Mendix style guide standards
2627

.claude/skills/docs-proofread/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Do NOT:
2222
* Change passive voice to active voice
2323
* Simplify complex sentences
2424
* Reorganize content
25+
* Remove Markdown comments
2526

2627
Priority order for determining scope:
2728
1. If the user has selected text in a file (check for `ide_selection` tags), only proofread the selected text in that file. Don't proofread the entire document.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Before creating a new file, use Glob to explore the directory structure and unde
7676

7777
* **Guiding manual** – Mendix-specific style guides (see subsection below) extend and customize the Microsoft Writing Style Guide (https://learn.microsoft.com/style-guide/). Consult the Mendix style guides first for grammar, inclusive language, terminology, and formatting rules; use MSG as fallback for topics not covered by Mendix guides.
7878
* **Tone** – Clear, concise, active voice; use imperative mood for procedures; second person (you/your) when addressing readers. Keep a conversational, straightforward tone. Present tense. Use American English and write for a global audience. Prefer short, everyday words; avoid or explain jargon. Keep it simple—short sentences and fragments are easier to scan and read, and prune excess words. Avoid marketing language.
79+
* **Person** – Avoid first-person plural (we, us, our, let's) in all documentation except release notes.
7980
* **Terminology** – Capitalize product names (Mendix, Studio Pro, Developer Portal); use "microflow", "nanoflow", etc. consistently. Never use e.g. or i.e.
8081
* **Text formatting** – Reserve bold for UI labels, button names, menu items, or other interface text, or for introductions in list items. Don't use italics except to refer to titles and sections. Use wording or alert shortcodes for emphasis; don't use text formatting for emphasis. Use code font only to wrap literal code, filenames, paths, or command-line input. Use `<kbd>` for keyboard shortcuts.
8182
* **Headings** – H1 is generated from the front‑matter title. Subsequent headings increment by one level at a time. Don't use bold or italics as a replacement for headings. Use title case. Never start headings with numerals.

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ To insert an em dash, use the keyboard shortcut <kbd>Alt</kbd> + <kbd>0151</kbd>
193193

194194
Write dates in the format **month day, year**, where:
195195

196-
* Month is the full month or a three-letter abbreviation
196+
* Month is the full month name
197197
* [Day is the cardinal number](#numbers) (16), not the ordinal number (16th)
198198
* Year is four digits
199199

@@ -461,11 +461,21 @@ Do not use ordinal numbers for dates (see [Dates](#dates)).
461461
462462
## Person
463463

464-
Address the reader of your documents using the second person instead of the first person: use "you" or "your" instead of "we", "our", or "us".
464+
Use imperative mood for instructions and second person (you, your) to address the reader. Use "you" instead of "user", or use "end-user" when referring to the user of a Mendix app built on the Mendix Platform.
465465

466-
Assume your reader is the person doing the tasks that you are documenting. Use "you" instead of "user", or use "end-user" when referring to the user of a Mendix app built on the Mendix Platform.
466+
Avoid first-person plural (we, us, our, let's) in all documentation except release notes.
467467

468-
Always use "Mendix" instead of "we" in the regular documentation. Use "we" only in the Studio Pro release notes, which are written from the perspective of PMs or developers.
468+
> Create a microflow. (Instead of "Let's create a microflow.")
469+
>
470+
> Add validation rules. (Instead of "We can add validation rules.")
471+
472+
When you need to emphasize that Mendix is the speaker, use phrasing like "Mendix recommends".
473+
474+
> Mendix recommends using the latest LTS version for production environments.
475+
476+
Release notes are an exception: they are written from Mendix's perspective and use "we" consistently.
477+
478+
> We fixed a bug where the debugger would crash when inspecting large objects.
469479
470480
## Procedures and Examples
471481

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ It is fine to use "Control Center."
8686

8787
### Mendix Marketplace
8888

89-
Capitalize in all instances, even when just writing "Marketplace."
89+
Capitalize in all instances, even when just writing "Marketplace." Use "Mendix Marketplace" on first mention in a document, then "Marketplace" for subsequent mentions. When there's risk of confusion with another marketplace (such as Siemens Marketplace), use "Mendix Marketplace" throughout.
9090

91-
It is fine to use "the Mendix Marketplace" or "the Marketplace."
91+
This is a product name, so don't add a definite article.
9292

9393
### Mendix Platform
9494

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,15 @@ Use "AM" and "PM" for times, via the MSG.
4343

4444
Use to refer to "< >".
4545

46-
## app/application
46+
## app
4747

48-
Use "app" or "application" when referring to apps in general. Do not capitalize (meaning, do not write "Mendix App").
48+
Use "app" instead of "application" in most cases, as [recommended by Microsoft](https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/app-application). Do not capitalize (meaning, do not write "Mendix App").
4949

50-
The full word "application" has a more well-rounded meaning to it (i.e., web and mobile apps), whereas "app" may connote just mobile app to the reader. Accordingly, it can be better to use "application" at the beginning of documents and then switch to "app" later on. We want to make it clear that Mendix is not just for building mobile apps, but all kinds of applications.
51-
52-
In the context of development and project management, sometimes using "project" can significantly enhance the clarity of the concept, as demonstrated in [Centralized Project Roles](/control-center/roles-and-permissions/#centralized-project-roles). In such cases, we can use "project" instead of "app" or "application". Note that such usage of "project" should be agreed upon between the Project Manager and the Technical Writer. For further guidelines, see [project](#project).
50+
In development and project management contexts, use "project" instead of "app" when it makes the concept clearer, such as in [Centralized Project Roles](/control-center/roles-and-permissions/#centralized-project-roles). For more guidance, see [project](#project).
5351

5452
## app owner
5553

56-
This is not a formalized/Mendix term, so we cannot assume the user knows what this is. This should be defined in general terms and made clearer via context (for example, via the "Copyright" example in the [Insights Hub module documentation](/partners/siemens/mindsphere-module-details/#configuring-the-os-bar)) that it is the user's responsibility to define and interpret what an app owner is for their app.
54+
This is not a formal Mendix term, so do not assume users know what it means. Define it in general terms and make clear through context that each team must define and interpret "app owner" for their own app. For an example, see the *Copyright* section in the [Insights Hub module documentation](/partners/siemens/mindsphere-module-details/#configuring-the-os-bar).
5755

5856
## article, document, page
5957

0 commit comments

Comments
 (0)