Adev Writing Guide

What it does

This skill provides guidance on writing content specifically for Angular documentation, adhering to both Google's technical writing standards and Angular-specific markdown conventions. It ensures consistency in tone, style, and formatting across all Angular documentation. The goal is to create clear, accessible, and helpful resources for developers using Angular.

When to use it

• When drafting new Angular developer documentation.
• When revising existing Angular documentation to ensure adherence to style guidelines.
• To maintain consistency in terminology and writing style within the Angular documentation set.

Key capabilities

• Provides guidance on tone and content, emphasizing a conversational yet professional approach.
• Offers advice on accessible language for a global audience.
• Covers formatting rules including sentence casing for headings, list types (numbered, bulleted, description), serial commas, code formatting, UI element styling, and date formatting.
• Details best practices for images, captions, and code samples within documentation.
• References the hierarchy of style guides to follow: project-specific guidelines, Google Developer Documentation Style Guide, Merriam-Webster, Chicago Manual of Style, and Microsoft Writing Style Guide.

Example prompts

• "Review this paragraph for adherence to Angular documentation style."
• "Suggest improvements to make this section more accessible to non-native English speakers."
• "Check the formatting of this code sample according to Angular documentation guidelines."

Tips & gotchas

• The skill prioritizes Google's technical writing standards and Angular-specific conventions. Project-specific style guides, if they exist, should be consulted first.
• Focus on explaining why code exists rather than simply describing what it does in comments.
• Always use standard American English spelling and punctuation.