documentation-standards

Enforce Adobe content writing standards across project documentation.

1.5k|257|Updated Nov 19, 2018
One-click install
npx skills add https://github.com/adobe/spectrum-web-components --skill documentation-standards-adobe
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/adobe/spectrum-web-components/tree/main/.ai/skills/documentation
Command: npx skills add https://github.com/adobe/spectrum-web-components --skill documentation-standards-adobe

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent documentation quality and voice across projects are reduced by applying a standardized Adobe content-writing approach.

Core Features & Use Cases

  • Enforces Adobe's Spectrum content standards across all documentation artifacts.
  • Improves clarity, consistency, and accessibility of API docs, guides, and internal notes.
  • Provides templates and best practices to accelerate writing and reviews.

Quick Start

Apply Adobe content writing standards to your current documentation tasks.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema
How do I enforce Adobe content writing standards across project documentation?

To enforce Adobe content writing standards, apply the Spectrum documentation approach to ensure consistency and quality across developer docs, user guides, Jira tickets, and PR descriptions with a unified voice and structure.

What is the best way to standardize API documentation voice and structure?

Standardizing API documentation voice involves adhering to frontmatter schemas, Markdown best practices, and example-driven explanations as demonstrated in Spectrum documentation to enforce a unified structure.

When do I need standardized guidelines for Jira tickets and PR descriptions?

You need standardized guidelines for Jira tickets and PR descriptions when a unified voice and structure are required across project artifacts to reduce inconsistent documentation quality.

Does this approach work with JSDoc and Markdown best practices?

Yes, this approach works with JSDoc by applying Adobe Spectrum content standards, requiring adherence to frontmatter schemas and Markdown best practices to improve clarity and consistency.

How to write developer docs that follow Spectrum content standards?

Write developer docs following Spectrum content standards by using templates and best practices to accelerate writing, ensuring example-driven explanations and frontmatter schema adherence for improved accessibility.

What problem does applying Adobe content writing standards solve?

Applying Adobe content writing standards solves the problem of inconsistent documentation quality and voice across projects by enforcing a standardized Adobe content-writing approach.