diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 681a0df6bc4..23c98cc48b5 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -57,7 +57,7 @@ Search the tree to understand where your topic belongs before creating a new fil * **Guiding manual** – Microsoft Writing Style Guide (https://learn.microsoft.com/style-guide/). Apply grammar, inclusive language, terminology, and formatting rules from that document. * **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. -* **Terminology** – Capitalize product names (Mendix, Studio Pro, Developer Portal); use “microflow”, “nanoflow”, etc. consistently. Never use e.g. or i.e. +* **Terminology** – Capitalize product names (Mendix Portal, Studio Pro, Team Server); use “microflow”, “nanoflow”, etc. consistently. Never use e.g. or i.e. * **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 `` for keyboard shortcuts. * **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 numbers. * **Lists and tables** – Bullet lists use asterisks; ordered lists use numbers followed by a period. If there are more than three data points per item, use a table instead. Use the same syntax and structure for all list items in a given list. Use complete sentences to introduce lists and tables, not partial sentences completed with the list items. diff --git a/CLAUDE.md b/CLAUDE.md index b9f3b6391ff..a7dc92a4cba 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -77,7 +77,7 @@ Before creating a new file, use Glob to explore the directory structure and unde * **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. * **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. * **Person** – Avoid first-person plural (we, us, our, let's) in all documentation except release notes. -* **Terminology** – Capitalize product names (Mendix, Studio Pro, Developer Portal); use "microflow", "nanoflow", etc. consistently. Never use e.g. or i.e. +* **Terminology** – Capitalize product names (Mendix Portal, Studio Pro, Team Server); use "microflow", "nanoflow", etc. consistently. Never use e.g. or i.e. * **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 `` for keyboard shortcuts. * **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. * **Lists and tables** – Bullet lists use asterisks; ordered lists use numbers followed by a period. If there are more than three data points per item, use a table instead. Use the same syntax and structure for all list items in a given list. Use complete sentences to introduce lists and tables, not partial sentences completed with the list items. diff --git a/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md b/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md index c127a3a4eef..e6029cd194f 100644 --- a/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md +++ b/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md @@ -155,7 +155,7 @@ Does not need to be capitalized, and "team" should be used without the qualifier ### app template -This is the term to use to reflect the create-new-app flow UI in the Developer Portal. +This is the term to use to reflect the create-new-app flow UI in Apps. Do not use "starter app." @@ -463,12 +463,6 @@ Do not use SBoM. Capitalize in all instances. -### Studio Pro landing page - -The Studio Pro landing page refers to the page that contains **My Apps**, **Marketplace**, and **Developer Portal** tabs. - -Capitalize "Studio Pro". - ### sub-microflow Spell with a hyphen. diff --git a/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md b/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md index 1b1ef5124d8..a09d5e0d95e 100644 --- a/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md +++ b/content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md @@ -148,7 +148,7 @@ Write as one word. ## deploy -The act of putting a Mendix app into an environment where it has access to all the resources it needs to run. This is triggered in the Developer Portal, or in the modeler by clicking **Run** or **Run Locally**. +The act of putting a Mendix app into an environment where it has access to all the resources it needs to run. This is triggered in Apps, or in Studio Pro by clicking **Run** or **Run Locally**. Use *deploy to* when referring to a cloud environment. @@ -324,11 +324,11 @@ Use lower-case unless it is part of a term like "Mendix Native Mobile Builder". ## navigation pane -Use to refer to the navigation interface on the left side of the screen in the Developer Portal. +Use to refer to the navigation interface on the left side of the screen in Apps. Do not capitalize. -> Select your app in the Developer Portal, then click **Backups** in the navigation pane. +> Select your app in Apps, then click **Backups** in the navigation pane. ## no-code, no code @@ -460,7 +460,7 @@ When referring to an action which is taking place, use "sign in" and "sign out" When referring to a button or other element of the UI, refer to the UI text. -> Sign out of the Developer Portal by clicking **Log out** in the menu under your avatar. +> Sign out of Apps by clicking **Log out** in the menu under your avatar. ## single sign-on @@ -512,7 +512,7 @@ Do not use "top left" and "top right". ## user vs. end-user -A "user" is a user of the Mendix Platform (apps in development, app projects, project management, Developer Portal, etc.). +A "user" is a user of the Mendix Platform (apps in development, app projects, project management, etc.). An "end-user" is a user of a Mendix app built on the platform. This term will be used less in the documentation, as we document for Mendix Platform users and not general Mendix app users in most cases.