Audit Markdown documentation for clarity and onboarding effectiveness.
npx skills add https://github.com/glaucia86/repocheckai --skill docs-audit-glaucia86
Please help me install this Agent Skill. Skill: docs-audit Source: https://github.com/glaucia86/repocheckai/tree/main/.github/skills/docs-audit Command: npx skills add https://github.com/glaucia86/repocheckai --skill docs-audit-glaucia86
This Skill addresses gaps in documentation clarity and onboarding processes, ensuring that essential information is present and easy to understand for new contributors.
Use the docs-audit skill to check the clarity and completeness of the project's README and CONTRIBUTING files.
High-intent search queries and answers about installing and using this skill.
To audit README onboarding clarity, the skill analyzes Markdown files to identify missing essential sections, confusing text, and unclear environment setup instructions for new contributors. It flags these specific areas and suggests actionable improvements.
Documentation auditing for contributor onboarding is the process of reviewing README and CONTRIBUTING files to ensure essential information is present, easy to understand, and facilitates effective new developer integration. It checks for clarity and actionable contribution guides.
To check if your CONTRIBUTING file has the right sections, the skill performs a presence verification against documentation best practices. It analyzes the Markdown content to ensure contribution guides are clear, complete, and actionable for new developers.
Yes, you can use this to improve confusing instructions in project documentation. The content clarity assessment specifically identifies confusing text within your README and CONTRIBUTING files, then suggests targeted improvements for better reader understanding.
No, the documentation audit requires no external dependencies or components. It operates by analyzing Markdown files directly and applying contextual understanding of documentation best practices to identify gaps in clarity and onboarding effectiveness.
The limitations of automated documentation auditing involve relying on contextual understanding of documentation best practices rather than subjective human judgment. It focuses strictly on presence of essential sections, text clarity, and contribution guide actionability within Markdown files.
hffmnnjGenerate a README.md with standard sections from project metadata.
No-Trade-No-LifeGenerate Markdown reports summarizing git commit ranges and contributors.
pkuppensUpdate creation and modification date tags in markdown and code files.
rysweetConvert architecture and workflow descriptions into valid Mermaid diagrams.
