Skip to content

Commit 6337d75

Browse files
ethanpalmclaude
andcommitted
Document style preferences learned from content refresh project
Add detailed style guide based on patterns identified during DOC-84 content refresh work, including: - Heading and formatting conventions - Component introduction patterns - Property description standards - Language and tone preferences - Code example best practices - Content organization principles These learnings will help maintain consistency in future documentation updates. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent a9f0e3e commit 6337d75

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.claude/CLAUDE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,41 @@
3434
- Use broadly applicable examples rather than overly specific business cases
3535
- Lead with context when helpful - explain what something is before diving into implementation details
3636

37+
### Style preferences (learned from content refresh project)
38+
#### Headings and formatting
39+
- Use sentence case for all headings ("Getting started", not "Getting Started")
40+
- Use "Properties" instead of "Props" for component documentation
41+
- Use sentence case for code block titles ("Expandable example", not "Expandable Example")
42+
43+
#### Component introductions
44+
- Start with action-oriented language: "Use [component] to..." rather than "The [component] component..."
45+
- Be specific about what components can contain or do
46+
- Make introductions practical and user-focused
47+
48+
#### Property descriptions
49+
- End all property descriptions with periods for consistency
50+
- Be specific and helpful rather than generic
51+
- Add scope clarification where needed (e.g., "For Font Awesome icons only:")
52+
- Use proper technical terminology ("boolean" not "bool")
53+
54+
#### Language and tone
55+
- Prefer active voice and direct language
56+
- Remove unnecessary words while maintaining clarity
57+
- Use "you complete" over "completing" for more direct communication
58+
- Break complex instructions into clear numbered steps
59+
- Make language more precise and contextual
60+
61+
#### Code examples
62+
- Keep examples simple and practical
63+
- Use consistent formatting and naming
64+
- Provide clear, actionable examples rather than showing multiple options when one will do
65+
66+
#### Content organization
67+
- Structure content in the order users need it
68+
- Combine related information to reduce redundancy
69+
- Use specific links (direct to relevant pages rather than generic dashboards)
70+
- Put most commonly needed information first
71+
3772
## Git workflow
3873
- NEVER use --no-verify when committing
3974
- Ask how to handle uncommitted changes before starting

0 commit comments

Comments
 (0)