@@ -207,6 +207,14 @@ Documentation should highlight value without becoming marketing copy.
207207- Multiple possible interpretations
208208- Missing context or assumptions
209209- Unclear cause-and-effect relationships
210+ - Anthropomorphizing inanimate objects (pages, tabs, sections)
211+
212+ ** Don't anthropomorphize entities:**
213+ - ❌ "The page manages your settings"
214+ - ✅ "The page lets you manage your settings"
215+ - ❌ "The Dashboard tracks subscriptions"
216+ - ✅ "The Dashboard displays subscription data" or "Use the Dashboard to track subscriptions"
217+ - Pages, tabs, and UI elements can't perform actions autonomously - they enable users to perform actions
210218
211219** Examples of fixes:**
212220
@@ -246,6 +254,13 @@ Documentation should highlight value without becoming marketing copy.
246254- Be consistent within each list
247255- Bold labels followed by descriptions use colons, not dashes: ` **Label**: Description. ` not ` **Label** - Description. `
248256
257+ ** Bullet lists vs. inline lists:**
258+ - Use bullet lists for 3+ items with links or important names - more scannable
259+ - ✅ "The page has three tabs:\n- [ General] ( #general ) \n- [ Subscription & Billing] ( #billing ) \n- [ Members] ( #members ) "
260+ - ❌ "The page has three tabs: [ General] ( #general ) , [ Subscription & Billing] ( #billing ) , and [ Members] ( #members ) ."
261+ - Inline lists are OK for short, simple items without links (e.g., "Supports iOS, Android, and web")
262+ - When in doubt, prefer bullet lists - they're easier to scan
263+
249264** Examples:**
250265
251266✅ ** Complete sentences - use periods:**
@@ -323,6 +338,12 @@ Requirements:
323338
324339** Why this matters** : Users scan for location keywords first. Stating location before action reduces cognitive load and prevents errors.
325340
341+ ** Keep location descriptions concise:**
342+ - ✅ "Click ** Account** at the top right"
343+ - ❌ "Click the link in the user menu in the top right corner of the Adapty Dashboard"
344+ - Use minimal words to identify the location - avoid over-describing navigation paths
345+ - Users can see the interface; they don't need verbose directions
346+
326347** More examples:**
327348
328349✅ "To enable Sandbox mode, in the App Settings, select ** Enable Sandbox** "
0 commit comments