← ClaudeAtlas

adev-writing-guidelisted

Comprehensive writing guide for Angular documentation (adev). Covers Google Technical Writing standards, Angular-specific markdown extensions, code blocks, and components. You MUST use this skill any time you plan to create, edit, or review documentation files in `adev/` or `adev/src/content`.
FJRG2007/enigma · ★ 2 · Web & Frontend · score 66
Install: claude install-skill FJRG2007/enigma
# Angular Documentation (adev) Writing Guide This skill provides comprehensive guidelines for authoring content in `adev/src/content`. It combines Google's technical writing standards with Angular-specific markdown conventions, components, and best practices. ## I. Google Technical Writing Guidelines ### Tone and Content - **Be conversational and friendly:** Maintain a helpful yet professional tone. Avoid being overly casual. - **Write accessibly:** Ensure documentation is understandable to a diverse global audience, including non-native English speakers. - **Audience-first:** Focus on what the user needs to do, not just what the system does. - **Avoid pre-announcing:** Do not mention unreleased features or make unsupported claims. - **Use descriptive link text:** Link text should clearly indicate the destination (e.g., avoid "click here"). ### Language and Grammar - **Use second person ("you"):** Address the reader directly. - **Prefer active voice:** Clearly state who or what is performing the action (e.g., "The system generates a token" vs "A token is generated"). - **Standard American English:** Use standard American spelling and punctuation. - **Conditional clauses first:** Place "if" or "when" clauses before the instruction (e.g., "If you encounter an error, check the logs"). - **Define terms:** Introduce new or unfamiliar terms/acronyms upon first use. - **Consistent terminology:** Use the same term for the same concept throughout the document. - **Conciseness:**