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

radius-author-doc

Creates new contributing docs in the standard Purpose through Troubleshooting format grounded in verified code references.

1.7k|135|Updated Feb 20, 2021
Search Tags:#contributing guide#Technical Writing#Documentation#radius#cspell#Developer workflow#doc authoring
One-click install
npx skills add https://github.com/radius-project/radius --skill radius-author-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: radius-author-doc
Source: https://github.com/radius-project/radius/tree/main/.github/skills/radius-author-doc
Command: npx skills add https://github.com/radius-project/radius --skill radius-author-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Contributor workflows in the Radius repository often lack documentation, or existing docs do not follow the prescribed structure. This Skill drafts a new contributing doc grounded in real code, following the repository's standard format, so contributors get accurate how-to guides without hallucinated paths or commands.

Core Features & Use Cases

  • Standardized Doc Authoring: Drafts docs using the required Purpose, Prerequisites, Steps, Verification, and Troubleshooting sections from the repository template.
  • Code-Grounded References: Verifies every path, command, and flag against actual source code before including it, and places the doc in the correct section of docs/contributing/.
  • Navigation Integration: Links the new page from the nearest index README or CONTRIBUTING.md and adds capability-index rows when the doc backs an agent capability.
  • Use Case: A maintainer adds a new Make target for local testing but no doc explains it. Invoke this Skill with the topic and the Make target to produce a verified contributing doc ready for human review.

Quick Start

Ask the agent to author a new contributing doc for a specific contributor workflow, providing the topic and a starting code reference such as a file, package, command, or Make target.

Frequently Asked Questions about radius-author-doc

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

FAQPage Schema
How do I write a new contributing doc for the Radius repository?▼

Provide the contributor workflow topic and a starting code reference such as a file, package, command, or Make target. The Skill copies the contributing-doc template, fills in the five standard sections, and verifies every reference against the actual source code.

What format must Radius contributing docs follow?▼

Contributing docs must contain five sections in order: Purpose, Prerequisites, Steps, Verification, and Troubleshooting. The template lives in docs/contributing/contributing-agent-assets.md, and docs are placed in the narrowest matching section of docs/contributing/.

When should I use radius-author-doc versus radius-update-doc?▼

Use radius-author-doc to create a new doc or expand a stub into the standard format. Use radius-update-doc when an existing doc has drifted from the code, and use radius-architecture-documenter for subsystem architecture docs.

Can this Skill write architecture documentation?▼

No. Architecture docs explaining how a subsystem works belong to the radius-architecture-documenter skill, which owns docs/architecture/. This Skill only authors how-to contributing docs for contributor workflows.

How is the generated doc verified before merging?▼

Every command, path, flag, and link must resolve to something real in the repository, and the doc must pass the spell checker via make spellcheck. A human reviews the draft before it is merged.

Related Skills

Explore More Software Engineering Skills→
radius-projectradius-project
1.7k

contributing-docs-updater

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

Official
Intermediate
matthabermehlmatthabermehl

doc-gardener

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

Community
Basic
ToanPV90ToanPV90

documentation-and-adrs

Document architectural decisions with ADRs capturing context and trade-offs.

Community
Basic
NimbleBrainIncNimbleBrainInc

hubspot

Manage HubSpot CRM contacts, deals, and company records via API.

Official
Intermediate