skills.rest
radius-project
radius-projectOFFICIAL
Explore all skills by this author →
WebsiteGitHub

radius-contributing-docs-updater

Audits contributor documentation for gaps and staleness and routes fixes to authoring skills.

1.7k|135|Updated Feb 20, 2021
Search Tags:#audit#gap analysis#Documentation#radius#Code review#doc impact#contributor docs
One-click install
npx skills add https://github.com/radius-project/radius --skill radius-contributing-docs-updater
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: radius-contributing-docs-updater
Source: https://github.com/radius-project/radius/tree/main/.github/skills/radius-contributing-docs-updater
Command: npx skills add https://github.com/radius-project/radius --skill radius-contributing-docs-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Contributor documentation drifts out of sync with code as repositories evolve, leaving new contributors blocked by missing guides or misled by stale commands. This Skill audits CONTRIBUTING.md, docs/contributing/, and docs/architecture/ to find what is missing or outdated, and assesses whether a given code change requires doc updates.

Core Features & Use Cases

  • Gap Analysis: Inventories existing contributor docs, cross-references them against actual repository workflows (build, test, CLI, release), and produces a prioritized gap table with proposed doc titles and locations.
  • Code Review Doc Impact Assessment: Categorizes a code change (new CLI flag, Makefile change, schema update, CI workflow) and returns a yes/no verdict on doc impact with specific target docs and sections.
  • Doc Review: Verifies proposed doc changes against the codebase, checking commands, paths, prerequisites, and consistency with writing guidelines.
  • Use Case: During review of a pull request that adds a new Make target, ask the Skill whether contributor docs need updating; it identifies the affected build guide and routes the fix to the radius-update-doc skill.

Quick Start

Ask the Skill to audit the contributor docs for gaps in TypeSpec workflows, or to assess whether your code change requires documentation updates.

Frequently Asked Questions about radius-contributing-docs-updater

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

FAQPage Schema
How do I find gaps in contributor documentation?▼

Run a gap analysis that inventories existing contributor docs, scans the repository for contributor-relevant workflows like build, test, and release processes, then cross-references them. The output is a prioritized table of missing docs with proposed titles, locations, and priority levels.

How do I know if a code change requires documentation updates?▼

Use the doc impact assessment mode, which categorizes the change (new CLI command, Makefile change, schema update, CI workflow) and maps it to likely affected doc areas. It returns a clear yes or no verdict with specific target docs and section-level guidance.

Can this skill write or fix documentation directly?▼

No, it only produces findings and routes the work. Creating new docs is delegated to the radius-author-doc skill and fixing drifted docs to the radius-update-doc skill, keeping assessment separate from authoring.

What documentation areas does the audit cover?▼

The audit covers CONTRIBUTING.md, everything under docs/contributing/, and docs/architecture/. It discovers the current directory structure at the start of every task rather than assuming fixed paths, since the layout may change over time.

Why does the skill verify commands against the codebase?▼

Docs frequently drift from reality as Make targets, scripts, and configs change. Verifying every command, path, and prerequisite against the actual repository ensures findings cite real sources of truth instead of repeating stale documentation claims.

Related Skills

Explore More Software Engineering Skills→
veryfrontveryfront
9

contribute

Guide new contributors through architecture, testing, and contribution processes for the veryfront-code repository.

Official
Intermediate
matthabermehlmatthabermehl

doc-gardener

Scan repository docs to detect stale, missing, or unreferenced documentation.

Community
Basic
radius-projectradius-project
1.7k

contributing-docs-updater

Updates CONTRIBUTING.md and related docs for repository workflow accuracy and consistency.

Official
Intermediate
GustavoGutierrezGustavoGutierrez

documentation-architect

Design scalable documentation ecosystems with ownership, lifecycle, and cross-linking standards.

Community
Advanced