Skip to content

Commit fd9c471

Browse files
Merge pull request #85271 from Expensify/claude-helpSiteGovernanceRuleUpdates
[NO QA] Strengthen help site governance rules for headings
2 parents 88ee5ad + 3c10b57 commit fd9c471

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

docs/HELPSITE_NAMING_CONVENTIONS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This document governs UI language conventions. It does not define article struct
1010

1111
docs/HELP_AUTHORING_GUIDELINES.md
1212

13+
Note: All article headings (# and ##) must follow the task-based heading rules in HELP_AUTHORING_GUIDELINES.md Section 2, except for `# FAQ` which is exempt. This includes section headings that reference UI features — they must still be task-based, not just feature labels.
14+
1315
---
1416

1517
# Core UI Referencing Rules

docs/HELP_AUTHORING_GUIDELINES.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,14 @@ If multiple workflows are detected → split into multiple articles.
3434
- Setup
3535
- Options
3636
- Step 1
37+
- Noun-only or topic-only headings that describe a category rather than a task
38+
- Platform-only labels used as headings (e.g., "iPhone", "Android", "Desktop", "Web")
39+
- Any heading that does not describe an action the user takes or a question the user has
3740

3841
## Requirements
3942

40-
- All headings must be:
41-
- Task-based
43+
- All headings must be (except `# FAQ`, which is exempt from task-based rules):
44+
- Task-based — must describe what the user will do or learn. Start with an action verb or question word (How, What, Where, Who, Why, When)
4245
- Searchable
4346
- Explicit
4447
- Feature-specific
@@ -48,6 +51,15 @@ If multiple workflows are detected → split into multiple articles.
4851
# Who can connect a business bank account in Expensify
4952
## Where to enable ACH reimbursements in a Workspace
5053
## How to troubleshoot bank connection errors in Expensify
54+
## How to enable Expensify Card notifications on iPhone
55+
56+
**Invalid → Corrected Examples**
57+
58+
-`## Transaction decline notifications` → ✅ `## How to understand why your Expensify Card transaction was declined`
59+
-`## iPhone` → ✅ `## How to enable notifications on iPhone`
60+
-`## Suspected fraud notifications` → ✅ `## What to do when you receive a fraud alert`
61+
-`## Banking and settlement notifications` → ✅ `## How banking and settlement alerts work for admins`
62+
-`## Card lifecycle notifications` → ✅ `## What card lifecycle notifications you'll receive`
5163

5264
---
5365

@@ -72,11 +84,15 @@ Metadata must reflect real search queries.
7284

7385
Each article must include:
7486
- YAML metadata
75-
- One primary # heading
76-
- Task-based ## sections
87+
- Exactly one # heading (the article title). No other # headings are allowed except # FAQ
88+
- Task-based ## sections for all content below the title
7789
- Sequential numbered steps (if procedural)
7890
- An FAQ section (if needed)
7991

92+
Do not use multiple # headings to organize an article into major sections. If content feels like it needs its own # heading, either:
93+
- Demote it to ## under the single # title, or
94+
- Split it into a separate article (per Section 1: one workflow per article)
95+
8096
If including an FAQ section, it must comply with:
8197
/docs/HELPSITE_NAMING_CONVENTIONS.md
8298

@@ -224,8 +240,12 @@ Prioritize screenshots for:
224240
# 9. Pre-Publish Validation Checklist
225241

226242
Before outputting an article, confirm:
227-
- Only # and ## used
228-
- No generic headings
243+
- Exactly one # heading (the article title), plus optional # FAQ — no other # headings
244+
- Only ## used for all content sections (no ### or deeper)
245+
- Every ## heading starts with an action verb or question word (How, What, Where, Who, Why, When)
246+
- `# FAQ` is exempt from task-based heading rules
247+
- No noun-only, topic-only, or platform-only headings
248+
- No generic headings (Overview, Introduction, Notes, Setup, Options, Step 1)
229249
- Feature names match UI
230250
- Metadata aligns with search intent
231251
- Navigation included (if applicable)

0 commit comments

Comments
 (0)