ux-key-reviewer

Validate UX copy key naming conventions in Markdown tables against project style guides.

1|Updated May 21, 2020
One-click install
npx skills add https://github.com/ahandsel/debugging_log --skill ux-key-reviewer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ux-key-reviewer
Source: https://github.com/ahandsel/debugging_log/tree/main/skills/ux-key-reviewer
Command: npx skills add https://github.com/ahandsel/debugging_log --skill ux-key-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the tedious process of auditing UX copy keys in Markdown tables, ensuring they strictly adhere to project-specific naming conventions and preventing localization errors.

Core Features & Use Cases

  • Naming Rule Enforcement: Validates keys against project-specific patterns, camelCase requirements, and segment separators.
  • Automated Reporting: Generates a structured report identifying violations, rule references, and suggested fixes.
  • Use Case: Before importing copy into a localization tool like Phrase, use this Skill to scan your PRD or design documentation to ensure all keys follow the required project identifier and modifier structure.

Quick Start

Use the ux-key-reviewer skill to audit the key naming compliance for the file located at tasks-kinid/v1-midfi/prd37-pw-mgt.md.

Frequently Asked Questions about ux-key-reviewer

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

FAQPage Schema
How do I audit UX copy keys in Markdown tables for naming convention compliance?

To audit UX copy keys in Markdown tables, this Skill validates your keys against project-specific naming conventions, checking for strict camelCase formatting and correct segment separation to ensure localization consistency.

How do I validate camelCase formatting and segment separators for localization keys?

Validating camelCase formatting and segment separators for localization keys is done by scanning your files to identify non-compliant UX copy keys, referencing the established project style guide, and generating a report with suggested standardized corrections.

Can I check PRD or design documentation for UX copy key violations before importing to a localization tool?

Yes, you can check PRD or design documentation for UX copy key violations before importing to a localization tool. The Skill scans technical documentation to enforce project identifier structures and modifier rules.

What is the best way to enforce project identifier rules across technical documentation and localization files?

The best way to enforce project identifier rules across technical documentation and localization files is to automate the audit process, which identifies non-compliant keys and generates structured reports with rule references and suggested fixes.

Why does my localization workflow fail when UX copy keys do not match project style guides?

Your localization workflow may fail when UX copy keys do not match project style guides because inconsistent naming conventions, incorrect camelCase formatting, and improper segment separation disrupt automated translation processing and segment mapping.

What are the limitations of automating UX copy key naming convention audits in Markdown?

A limitation of automating UX copy key naming convention audits in Markdown is that the Skill operates strictly within Markdown table structures and relies on predefined project style guides, meaning it cannot process non-Markdown formats or infer unwritten naming rules.