skills.rest
joaomcarlos
joaomcarlosCOMMUNITY
Explore all skills by this author →
GitHub

atlasmd-docs-conformance-score

Scores documentation sets against the AtlasMD Documentation Standard with per-section analysis.

Updated Aug 4, 2026
Search Tags:#documentation#markdown#audit#link checker#conformance#quality score#atlasmd
One-click install
npx skills add https://github.com/joaomcarlos/AtlasMD --skill atlasmd-docs-conformance-score-joaomcarlos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: atlasmd-docs-conformance-score
Source: https://github.com/joaomcarlos/AtlasMD/tree/main/ai/skills/atlasmd-docs-conformance-score
Command: npx skills add https://github.com/joaomcarlos/AtlasMD --skill atlasmd-docs-conformance-score-joaomcarlos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation teams lack an objective way to measure whether their docs follow a defined standard, making it hard to find structural gaps, broken links, and writing quality issues before readers do. ## Core Features & Use Cases - Dual Headline Scores: Produces a Quality score and a Conformance score (0-100 with A-F grades), plus a separate Link Health score from automated link checking. - Per-Section Analysis: Evaluates each present section against the AtlasMD standard with severity-rated findings, concrete suggestions, and strengths, while never penalizing for absent sections. - Automated Link Auditing: Runs link-fixing and broken-link-checking scripts as a background sub-agent and reports failure breakdowns by type. - Use Case: Before a product release, run an audit of your user guide to get a conformance report with ranked improvement priorities and a full list of broken links to fix. ## Quick Start Score the documentation in my docs folder against the AtlasMD standard and produce a conformance report.

Frequently Asked Questions about atlasmd-docs-conformance-score

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

FAQPage Schema
How do I audit documentation against a documentation standard?▼

Load this skill and point it at your documentation directory. It reads the AtlasMD Documentation Standard, evaluates each present section for structural conformance and content quality, runs a link checker, and produces a scored report with findings and suggestions.

How to check broken links in markdown documentation?▼

The skill runs fix-common-links.py to normalize links, then check-broken-links.py to find broken ones. It reports total links checked, OK and broken counts, and a failure breakdown by not-found, anchor-not-found, and unreachable types.

Does the conformance score penalize missing sections like API reference?▼

No. The skill identifies the guide type first and only scores sections that are present. Absent sections such as API reference in a user-guide-only project are noted as observations but excluded from scoring.

What does the documentation conformance report include?▼

The report includes headline Quality, Conformance, and Link Health scores with A-F grades, link statistics, per-section analysis with strengths and severity-rated findings, absent-section observations, ranked improvement priorities, and a narrative summary.

When should I not use automated documentation scoring?▼

Automated scoring is less useful when documentation has no agreed standard to measure against, or when you need deep domain-expert validation of technical accuracy beyond what can be verified against code and configuration.

Related Skills

Explore More Content & Communication Skills→
RonanCodesRonanCodes

doc-standards

Enforce standardized Markdown documentation structure with mermaid diagrams and valid links.

Community
Intermediate
PluseroPlusero
3

paper-readability-check

Review academic paper drafts against a 15-item readability checklist and produce before/after revision reports.

Community
Intermediate
PracticalSwanPracticalSwan
7

documentation-automation

Configure markdownlint, link checkers, and pre-commit hooks for documentation validation.

Community
Intermediate
beam-ai-teambeam-ai-team

qa-checklist

Transform technical AI documentation into business-owner cheatsheets with Markdown sections.

Official
Intermediate