To ensure your guide is clear, helpful, and consistent with our style, follow the guidelines below:
| info |
Information These rules apply to all sections of your guide. |
- Tone of Voice: Write in a helpful, clear, and direct tone. Assume the reader is a marketer or product manager who may have some technical knowledge but is not an engineer.
- UI Elements: Bold any user interface elements like button names, menu items, or field labels.
For Example: "Navigate to Settings > Connectors and click + Add Connector." - Placeholders: Use
<placeholder_text>for any values the user needs to enter themselves.
For Example: "Enter your<YOUR_API_KEY>in the Authorization field." - Code and Payloads: Use code blocks for API payloads, URLs, or code snippets.
For Example:
<sample code>- Screenshots: Provide clear, up-to-date, and high-resolution screenshots for each major step. Annotate them to highlight important areas.
For Example:- High Quality: All screenshots must be high-resolution, up-to-date, and clearly legible.
- Targeted Focus: Crop screenshots to show only the relevant parts of the interface.
- Annotation Color: All annotations (boxes, arrows, circles, highlights) must be red. This creates a consistent visual language for the user.
- Use a red box to highlight a larger section or area.
- Use a red arrow to point to a specific button, link, or field the user needs to interact with.
- Use a red circle to draw attention to a single, crucial piece of information.