adobe / adobe/spectrum-design-data

Phase 5: Glossary Content QA and Review

Open
#664 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Rust
Stars
153
Forks
35
Avg merge
7h 54m
Merged PRs (30d)
111

Description

## Overview

Perform comprehensive content quality assurance and review with content strategists to ensure glossary accuracy and completeness.

**Related**: RFC Discussion #661 - Spectrum Design System Glossary

## Stakeholders

- **Content Strategists**: Jess Sattell, Kari Brookmyer
- **Platform Leads**: iOS, Android, Web Components, Qt teams
- **Token Team**: For token terminology validation

## Deliverables

### 1. Content Audit
- [ ] Create comprehensive inventory of all wiki sources
- [ ] Create migration spreadsheet tracking all terms
- [ ] Identify gaps in current coverage
- [ ] Check for missing terms in component schemas, token names, anatomy, platforms

### 2. Definition Review
- [ ] Review all 179+ registry terms with content strategists
- [ ] Verify definitions follow Naming Guide methodology
- [ ] Check superordinate accuracy
- [ ] Verify essential characteristics
- [ ] Validate terminology classification

### 3. Cross-Reference & Platform Validation
- [ ] Verify all related terms references
- [ ] Review platform terminology with platform teams
- [ ] Check platform code examples
- [ ] Validate platform documentation references

### 4. Quality & Accessibility
- [ ] Spell check, grammar review
- [ ] URL validation
- [ ] Web viewer accessibility testing (WCAG 2.1 AA)
- [ ] Performance testing

## Dependencies

- Phase 1: Content migration complete ✅
- Phase 3: Web viewer deployed

## Estimated Effort

1 week

## Related

- RFC: https://github.com/adobe/spectrum-design-data/discussions/661

Contributor guide

Open the contributing guide

Research direction

Start with RFC Discussion #661, then inventory the wiki sources and migration spreadsheet described in the issue. Review the 179+ registry terms with the content strategists and platform teams; done means the listed audits, validations, accessibility checks, and performance testing are completed and tracked.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, content, documentation, performance, testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.