ux-readiness

You can assess app flows for documentation readiness by evaluating routes against defined criteria for blockers and friction. This ensures all necessary application paths are stable, preventing wasted documentation effort on broken flows.

UX readiness scoring evaluates application user experience flows to determine if they are ready for documentation. It flags issues that would hinder a user's ability to follow a guide successfully.

To create GitHub issues for UX blockers and friction, use an automated assessment tool that categorizes identified problems. This requires the GitHub CLI for issue management during the route evaluation process.

Yes, you need the GitHub CLI installed to evaluate UX readiness because the assessment requires it for issue management. It is used to automatically create and triage issues for identified blockers and friction.

To synchronize UX readiness state with a documentation repository, manage a shared tracker file via direct file access. This cross-repo sync coordinates readiness updates with your documentation pipeline efforts.

You should avoid running an app flow assessment if your routes are highly unstable or if you lack direct file access for cross-repo state synchronization. It is designed for stable features ready for documentation preparation.