Skip to content

Create docs-convention skills - #3194

Open
dessyordanova wants to merge 4 commits into
masterfrom
dess-skills
Open

Create docs-convention skills#3194
dessyordanova wants to merge 4 commits into
masterfrom
dess-skills

Conversation

@dessyordanova

Copy link
Copy Markdown
Collaborator

The purpose is to have automatic verification with each PR Copilot review for the main docs conventions

Skill Purpose
accessibility-doc-optimization Scores Markdown accessibility against WCAG-oriented practices, including headings, alt text, links, tables, plain language, formatting independence, callouts, and code blocks.
llm-doc-optimization Evaluates whether documentation is easy for LLMs and agents to retrieve, chunk, parse, and reason over. It checks structure, self-contained sections, terminology, code, metadata, links, and formatting.
seo-doc-optimization Scores traditional and modern SEO quality, covering metadata, keywords, content depth, links, slugs, structured data, search intent, E-E-A-T, task completion, and AI-era content quality.
style-guide-scoring Provides the broadest review against the Progress DevTools Style Guide, including metadata, headings, tone, grammar, formatting, lists, punctuation, and article completeness.

Copilot AI lite review requested due to automatic review settings August 10, 2026 13:58
@dessyordanova dessyordanova self-assigned this Aug 10, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds four GitHub “skill” definitions under .github/skills/ to enable consistent, automated Copilot-based scoring of documentation quality across core convention areas (style guide compliance, SEO, LLM/agent readability, and accessibility).

Changes:

  • Introduces a style-guide scoring skill with weighted dimensions aligned to the Progress DevTools Style Guide.
  • Introduces SEO and modern ranking-factor scoring (technical SEO + intent/E-E-A-T/usefulness/AI-era quality).
  • Introduces LLM/agent readability scoring and accessibility (WCAG-oriented) scoring skills, each with weighted JSON outputs.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
.github/skills/style-guide-scoring/SKILL.md Defines a weighted rubric to score a Markdown article against the Progress DevTools Style Guide and output structured JSON.
.github/skills/seo-doc-optimization/SKILL.md Defines a weighted rubric for technical + modern SEO scoring of documentation with structured JSON output.
.github/skills/llm-doc-optimization/SKILL.md Defines a weighted rubric to evaluate how well docs are chunked/retrieved/reasoned over by LLMs/agents with structured JSON output.
.github/skills/accessibility-doc-optimization/SKILL.md Defines a weighted rubric to score documentation accessibility against WCAG-oriented practices with structured JSON output.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/skills/seo-doc-optimization/SKILL.md Outdated
Comment thread .github/skills/llm-doc-optimization/SKILL.md Outdated
Comment thread .github/skills/accessibility-doc-optimization/SKILL.md Outdated
dessyordanova and others added 3 commits August 10, 2026 17:12
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants