adev-writing-guide

Standardize Angular documentation authoring with Google technical writing guidelines and markdown conventions.

Updated Nov 24, 2021
One-click install
npx skills add https://github.com/ishiyan/Mbng --skill adev-writing-guide-ishiyan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adev-writing-guide
Source: https://github.com/ishiyan/Mbng/tree/main/.opencode/skills/angular-adev-writing-guide
Command: npx skills add https://github.com/ishiyan/Mbng --skill adev-writing-guide-ishiyan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Authoring consistent, accessible Angular documentation by combining Google Technical Writing standards with Angular-specific markdown extensions and components.

Core Features & Use Cases

  • Guidelines integration: Merges Google's technical writing rules with Angular markdown conventions to standardize terminology, tone, and structure.
  • Authoring support: Helps writers craft content for adev/src/content with correct code block formatting, UI element styling, and sectioning.
  • Review & quality: Provides a reference for reviewers to validate documentation against a unified style.

Quick Start

Apply this guide when authoring or reviewing content in adev/src/content to ensure consistent, accessible Angular documentation.

Frequently Asked Questions about adev-writing-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the Angular documentation writing guidelines for adev?

Angular documentation writing guidelines combine Google's technical writing standards with Angular-specific markdown conventions to standardize terminology, tone, and structure for adev/src/content.

How do I format markdown code blocks in Angular tutorials?

Format markdown code blocks in Angular tutorials by applying Angular-specific markdown extensions that enforce correct code block formatting, UI element styling, and sectioning for accessible, production-ready documentation.

Does the Angular documentation style guide apply to reference content and guides?

Yes, the Angular documentation style guide applies to adev/src/content across guides, tutorials, and reference content, ensuring consistent tone, structure, and code formatting for all authoring and review.

What is the best way to standardize terminology when writing Angular docs?

The best way to standardize terminology when writing Angular docs is to follow Google's technical writing rules merged with Angular markdown conventions, ensuring clear and consistent authoring throughout.

How do I review Angular documentation for consistent tone and structure?

Review Angular documentation for consistent tone and structure by validating content against a unified style that merges Google technical writing standards with Angular markdown conventions and component formatting rules.

Why does my Angular documentation fail accessibility and style checks?

Angular documentation fails accessibility and style checks when it does not adhere to the described style rules, terminology, and formatting required to generate clear, accessible, and production-ready docs.