Evaluate documentation quality across 8 dimensions and 32 sub-metrics.
npx skills add https://github.com/acardozzo/rx-suite --skill doc-rx
Please help me install this Agent Skill. Skill: doc-rx Source: https://github.com/acardozzo/rx-suite/tree/main/skills/doc-rx Command: npx skills add https://github.com/acardozzo/rx-suite --skill doc-rx
This Skill addresses the challenge of poor project documentation, which hinders onboarding, increases maintenance costs, and frustrates developers. It ensures projects are understandable and maintainable.
Run the doc-rx skill to audit the documentation quality of the current project.
High-intent search queries and answers about installing and using this skill.
You can audit documentation quality by evaluating project readability across 8 dimensions including READMEs, API docs, code comments, ADRs, onboarding guides, changelogs, tutorials, and error messages. This process generates a scored report with actionable recommendations to improve developer experience.
Developer experience documentation determines whether new developers can understand, onboard, and contribute to a project effectively. Poor documentation increases maintenance costs and frustrates developers, while a structured audit ensures projects remain understandable and maintainable over time.
Identify gaps in onboarding guides and API docs by assessing them against 32 sub-metrics covering architecture understanding and contribution workflows. This evaluation produces an opportunity map and per-dimension improvement plans to prioritize missing information.
Yes, you can evaluate architecture decision records and changelogs without external dependencies. The audit runs as a standalone script using built-in references to assess technical writing completeness and generate a scorecard for your project's documentation.
The best way to improve technical writing and code comments is to run a comprehensive documentation audit. It assesses readability and coverage across 32 sub-metrics, providing a scorecard and prioritized action items to enhance the onboarding experience for new contributors.
tomgunUpdate README, CHANGELOG, and API docs after code changes.
lemigAudit developer experience by testing onboarding flows, docs navigation, and CLI help.
TeiNamAutomate Laravel project verification for CI/CD pipelines.
rajyeole6Standardize creation and maintenance of README files, API references, and developer tutorials.
