writing-vads-guidance

Enforce VADS templates and style standards in documentation workflows.

74|86|Updated Oct 11, 2018
One-click install
npx skills add https://github.com/department-of-veterans-affairs/vets-design-system-documentation --skill writing-vads-guidance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-vads-guidance
Source: https://github.com/department-of-veterans-affairs/vets-design-system-documentation/tree/main/.claude/skills/writing-vads-guidance
Command: npx skills add https://github.com/department-of-veterans-affairs/vets-design-system-documentation --skill writing-vads-guidance

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps writers ensure documentation for the VA Design System follows established templates and style standards, preventing drift and ensuring consistency across docs.

Core Features & Use Cases

  • Enforce adherence to VADS templates and style standards.
  • Guide contributors through doc-queue workflows and updating guidance.
  • Provide a structured approach to creating component/pattern/template documentation that aligns with VADS.

Quick Start

Announce at start: "I'm using the writing-vads-guidance skill to help write documentation that follows VADS standards." Use this skill to draft new or updated VADS documentation that adheres to the templates and style guidelines.

Frequently Asked Questions about writing-vads-guidance

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

FAQPage Schema
How do I write documentation that follows VADS style standards and templates?

To write documentation following VADS style standards, draft content that enforces adherence to YAML front matter, section structure, and content guidelines. This ensures new component, pattern, and template guidance remains consistent across the VA Design System.

What is the doc-queue workflow for updating VA Design System guidance?

The doc-queue workflow for updating VA Design System guidance involves applying VADS templates and style standards to new or existing documentation. This process enforces compliance with YAML front matter and section structure to maintain consistent, polished standards.

Do I need YAML front matter for VADS component documentation?

Yes, YAML front matter is required for VADS component documentation. The VADS style guidelines enforce adherence to YAML front matter alongside section structure and content guidelines to prevent documentation drift and ensure consistency.

How do I ensure consistent formatting across VADS pattern documentation?

Ensure consistent formatting across VADS pattern documentation by applying established templates and style guidelines throughout the writing process. This enforces adherence to required section structures and content guidelines defined by the VA Design System.

Can I use this approach to update existing VA Design System documentation?

Yes, you can use this approach to update existing VA Design System documentation. It applies VADS templates and style standards to both writing new component guidance and updating existing docs, ensuring compliance throughout the documentation process.

What's the best way to prevent documentation drift in a design system?

The best way to prevent documentation drift in a design system is to enforce adherence to established templates, style standards, YAML front matter, and section structure. This structured approach ensures all component and pattern guidance aligns consistently.