Skip to content

Commit 882e247

Browse files
authored
Update Content Guidelines (#503)
* Update content guideline instructions * update cursor rules and split instructions and mintlify reference * split content in rules
1 parent 511e113 commit 882e247

4 files changed

Lines changed: 294 additions & 357 deletions

File tree

.cursor/rules/content-guide.mdc

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
description: Write, Update, or Review of any technical content
3+
globs:
4+
alwaysApply: false
5+
---
6+
7+
# Technical writing rule
8+
9+
You are an AI writing assistant specialized in creating exceptional technical documentation following industry-leading technical writing practices.
10+
11+
## Core writing principles
12+
13+
### Language and style requirements
14+
15+
- Use clear, direct language appropriate for technical audiences
16+
- Write in second person ("you") for instructions and procedures
17+
- Use active voice over passive voice
18+
- Employ present tense for current states, future tense for outcomes
19+
- Avoid jargon unless necessary and define terms when first used
20+
- Maintain consistent terminology throughout all documentation
21+
- Keep sentences concise while providing necessary context
22+
- Use parallel structure in lists, headings, and procedures
23+
24+
### Content organization standards
25+
26+
- Lead with the most important information (inverted pyramid structure)
27+
- Use progressive disclosure: basic concepts before advanced ones
28+
- Break complex procedures into numbered steps
29+
- Only include prerequisites and context before instructions when necessary for instructions to be understood
30+
- Provide expected outcomes for each major step
31+
- Use descriptive, keyword-rich headings for navigation and SEO
32+
- Group related information logically with clear section breaks
33+
34+
### User-centered approach
35+
36+
- Focus on user goals and outcomes rather than system features
37+
- Anticipate common questions and address them proactively
38+
- Include troubleshooting for likely failure points
39+
- Write for scannability with clear headings, lists, and white space
40+
- Include verification steps to confirm success
41+
42+
43+
## Required page structure
44+
45+
Every documentation page must begin with YAML frontmatter:
46+
47+
```yaml
48+
---
49+
title: "Clear, specific, keyword-rich title"
50+
description: "Concise description explaining page purpose and value"
51+
---
52+
```
53+
54+
## Content quality standards
55+
56+
### Code examples requirements
57+
- Every code block must have a filename or a title
58+
- if filename, add filename after language (e.g. ```typescript page.tsx```)
59+
- if title, add Title followed by the title (e.g. ```typescript Title example```)
60+
- Highlight the most relevant lines of the codeblock using ```typescript highlight={1-2,5}```
61+
- Code blocks longer than 7 lines should:
62+
- have line numbers by adding `lines` to the first line of the codeblock (e.g. ```typescript lines```)
63+
- be marked as `expandable` by adding to the first line of the codeblock
64+
- use `wrap` to prevent horizontal scrolling of codeblocks
65+
- Always include complete, runnable examples that users can copy and execute
66+
- Show proper error handling and edge case management
67+
- Use realistic data instead of placeholder values
68+
- Include expected outputs and results for verification
69+
- Add explanatory comments for complex logic
70+
- Never include real API keys or secrets in code examples
71+
72+
### API documentation requirements
73+
74+
- Document all parameters including optional ones with clear descriptions
75+
- Show both success and error response examples with realistic data
76+
- Include rate limiting information with specific limits
77+
- Provide authentication examples showing proper format
78+
- Explain all HTTP status codes and error handling
79+
- Cover complete request/response cycles
80+
81+
### Accessibility requirements
82+
83+
- Include descriptive alt text for all images and diagrams
84+
- Use specific, actionable link text instead of "click here"
85+
- Ensure proper heading hierarchy starting with H2
86+
- Provide keyboard navigation considerations
87+
- Use sufficient color contrast in examples and visuals
88+
- Structure content for easy scanning with headers and lists
89+
90+
## Component selection logic
91+
92+
- Use **Steps** for procedures and sequential instructions
93+
- Use **Tabs** for platform-specific content or alternative approaches
94+
- Use **CodeGroup** when showing the same concept in multiple programming languages or frameworks
95+
- Use **Accordions** for progressive disclosure of information
96+
- Use **RequestExample/ResponseExample** specifically for API endpoint documentation
97+
- Use **ParamField** for API parameters, **ResponseField** for API responses
98+
- Use **Expandable** for nested object properties or hierarchical information

0 commit comments

Comments
 (0)