Create docs-convention skills - #881
Open
dessyordanova wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds four reusable GitHub “skills” under .github/skills/ intended to automatically score Markdown documentation against key docs conventions (style guide, SEO, accessibility, and LLM/agent readability) and return structured JSON results suitable for automated PR review workflows.
Changes:
- Introduces a style-guide scoring skill with weighted dimensions and a JSON output contract.
- Introduces SEO scoring dimensions spanning technical SEO plus modern ranking factors (intent, E-E-A-T, usefulness, AI-era quality).
- Introduces LLM/agent readability scoring focused on chunking, terminology consistency, and structure.
- Introduces accessibility scoring aligned to WCAG-oriented documentation practices with weighted dimensions.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| .github/skills/style-guide-scoring/SKILL.md | Defines weighted style-guide scoring rules and JSON output schema. |
| .github/skills/seo-doc-optimization/SKILL.md | Defines SEO scoring rubric and JSON output schema (technical + modern SEO). |
| .github/skills/llm-doc-optimization/SKILL.md | Defines LLM/agent-readability scoring rubric and JSON output schema. |
| .github/skills/accessibility-doc-optimization/SKILL.md | Defines accessibility-focused scoring rubric and JSON output schema. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| * Numbers (`numbers.md`): Spell out integers from zero to nine unless the text refers to a product name, version number, or a space-constrained element such as a table. Use digits for 10 and above. Use period-separated decimals (`10.6`). Use an en dash for ranges (`1–15`) with no spaces. Do not begin sentences, titles, headings, or captions with numerals. | ||
| * Vocabulary and terminology (`vocabulary.md`, `brandnames.md`, `click-tap-select.md`, `personal-pronouns.md`): Prefer `checkbox`; use `click X` and `tap X`; use `hover over` as the verb and `hover` or `hovering` as the noun or adjective; prefer `unavailable` over `disabled` or `grayed out` for irrelevant UI state; use `earlier` and `later` for versions; use `starting with` instead of `since` or `as of` for version introductions; preserve official company, product, and third-party spelling; prefer gender-neutral pronouns or rewrite to avoid unnecessary gendering. | ||
| * Programming language display names: In prose, headings, and code-block labels (tab headers, bold introductions), always write **C#** and **VB.NET**. Do not use alternative forms such as "csharp", "CSharp", "C Sharp", "vb", "VB", "Visual Basic", or "VB.Net". The fenced-code-block language tag must also follow this rule: use ` ```C# ` and ` ```VB.NET ` instead of ` ```csharp ` or ` ```vb `. |
|
|
||
| | Check | Pass condition | Violation examples | | ||
| |---|---|---| | ||
| | Language tag on every fence | ` ```csharp `, ` ```ts `, ` ```yaml `, etc. | ` ``` ` with no language | |
|
|
||
| | Check | Pass condition | Violation examples | | ||
| |---|---|---| | ||
| | Language tag on every fenced code block | Every ` ``` ` fence specifies a language: ` ```csharp `, ` ```bash `, ` ```json `, etc. | ` ``` ` with no language tag | |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The purpose is to have automatic verification with each PR Copilot review for the main docs conventions