us-readability-check

What problem does it solve?

This Skill addresses the challenge of User Stories (US) containing technical jargon or being too concise, making them difficult for non-technical stakeholders like Product Managers, Business Analysts, or clients to understand. It ensures US are clear, descriptive, and business-friendly.

Core Features & Use Cases

• Technical Term Detection: Identifies and flags jargon like "API," "JSON," "SQL," etc., suggesting business-friendly alternatives.
• Readability Assessment: Checks for overly concise expressions and lack of context, prompting for more descriptive language.
• Scenario Enrichment: Helps identify missing elements like specific roles, times, or locations to make the US more concrete.
• Use Case: After drafting a set of User Stories for a new e-commerce feature, run this Skill to ensure they are easily understood by the marketing team before client review, preventing misunderstandings and rework.

Quick Start

Run the us-readability-batch command to check all user stories in the requirements directory.