Skip to content

[Payment due @mananjadhav] [No QA] Update HELPSITE_NAMING_CONVENTIONS.md #90856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NicolasBonet merged 1 commit into from
May 19, 2026
Merged

[Payment due @mananjadhav] [No QA] Update HELPSITE_NAMING_CONVENTIONS.md #90856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/HELPSITE_NAMING_CONVENTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,18 +84,14 @@ Formatting requirements:
- Always bold the symbol.
- Always include the words “three dots” before the symbol.
- Do not wrap in quotation marks.
- Do not call it “More”.
Comment thread
stephanieelliott marked this conversation as resolved.
- Do not write “More menu”.

Correct:
- Select the three dots **(⋮)**.
- Click the three dots **(⋮)** next to the expense.

Incorrect:
- Click More
Comment thread
stephanieelliott marked this conversation as resolved.
- Select “: More”
- Tap the three dots
- Open the More menu
- Open the three dots menu
- Click ⋮

---
Expand All @@ -111,10 +107,10 @@ Follow the platform decision hierarchy below.
Provide separate instructions.

Web:
Use the navigation tabs on the left.
In the navigation tabs on the left.
Comment thread
stephanieelliott marked this conversation as resolved.

@github-actions github-actions Bot May 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readability / structure violation: "In the navigation tabs on the left." is a prepositional phrase fragment, not a complete instruction. The previous phrasing ("Use the navigation tabs on the left.") was an imperative sentence, which aligns with HELP_AUTHORING_GUIDELINES.md Section 5 requiring step instructions to be "Action-oriented." Since this governance file sets the standard for all HelpDot articles, the example phrasing should itself be a valid, complete instruction.

Consider restoring the imperative form or using another action verb, e.g.:

  • "Use the navigation tabs on the left."
  • "Click the navigation tabs on the left."


Mobile:
Use the navigation tabs on the bottom.
In the navigation tabs on the bottom.
Comment thread
stephanieelliott marked this conversation as resolved.

@github-actions github-actions Bot May 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readability / structure violation: Same issue as the Web example above -- "In the navigation tabs on the bottom." is a sentence fragment, not an actionable instruction. Step formatting standards in HELP_AUTHORING_GUIDELINES.md Section 5 require instructions to be "Action-oriented." Consider using an imperative form such as "Use the navigation tabs on the bottom." or "Tap the navigation tabs on the bottom."


Do not merge these into one sentence.

Expand All @@ -124,7 +120,7 @@ Do not merge these into one sentence.

Use a unified sentence:

Click the navigation tabs (on the left on web, on the bottom on mobile).
In the navigation tabs (on the left on web, on the bottom on mobile).
Comment thread
stephanieelliott marked this conversation as resolved.

@github-actions github-actions Bot May 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readability / structure violation: "In the navigation tabs (on the left on web, on the bottom on mobile)." is a prepositional phrase fragment, not a complete sentence. This is the unified-sentence template that article authors will copy, so it should model correct, action-oriented phrasing per HELP_AUTHORING_GUIDELINES.md Section 5. Consider restoring the imperative form, e.g.: "Click the navigation tabs (on the left on web, on the bottom on mobile)."


Do not duplicate instructions unnecessarily.

Expand Down
Loading