skills.rest
dotnet
dotnetOFFICIAL
Explore all skills by this author →
Website𝕏@dotnetfdnGitHub

update-agent-docs

Updates the Roslyn agent knowledge base after code changes to keep memory files current.

20.6k|4.3k|Updated Jan 11, 2015
Search Tags:#agent memory#Roslyn#Documentation#public api#Knowledge Base#Code maintenance
One-click install
npx skills add https://github.com/dotnet/roslyn --skill update-agent-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-agent-docs
Source: https://github.com/dotnet/roslyn/tree/main/.github/skills/update-agent-docs
Command: npx skills add https://github.com/dotnet/roslyn --skill update-agent-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After modifying code in the Roslyn repository, the agent knowledge base in .github/memory/ and .github/instructions/ can become stale, causing future contributors and AI agents to rely on outdated file maps, API references, and conventions.

Core Features & Use Cases

  • Checklist-Driven Updates: Maps each type of change (files moved, public APIs modified, new diagnostics, new patterns) to the specific memory or instructions file that must be updated.
  • Documentation Quality Rules: Ensures docs describe the repository's current state rather than the history or mechanics of the change being made.
  • New Doc Creation Guidance: Defines how to create new memory files with minimal YAML frontmatter containing only a coverage field, plus registration in INDEX.md.
  • Use Case: After adding a new compiler error code and its resource strings, run this Skill to update the matching area instructions file, verify ErrorCode.cs and .resx consistency, and record any new conventions.

Quick Start

Update the agent knowledge base to reflect the code changes I just made in this task.

Frequently Asked Questions about update-agent-docs

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

FAQPage Schema
How do I keep AI agent documentation up to date after code changes?▼

Run a documentation update pass at the end of every task that modifies code. Follow a checklist that maps each change type, such as moved files or new public APIs, to the specific memory or instructions file that must be updated.

What files need updating when I change a public API in Roslyn?▼

Update the matching .github/instructions/<area>.instructions.md file for Compiler or IDE changes, and edit the owning project's PublicAPI.Unshipped.txt, which the RS0016 analyzer enforces. API_MAP.md only covers repo-wide entry points.

When should I run the update-agent-docs skill?▼

Run it at the end of every task that modifies code, adds or moves files, changes public APIs or diagnostics, or establishes new patterns. It is treated as a mandatory final step, not an optional one.

Can I create new documentation files in the Roslyn memory directory?▼

Yes, you can create new files in .github/memory/ without permission when knowledge does not fit existing files. Add minimal YAML frontmatter with only a coverage field and register the file in INDEX.md.

What should agent documentation not include?▼

Documentation should not describe the history or mechanics of the change being made, reference removed behavior, or warn against workarounds that no longer exist. It should only help a future contributor starting from a clean checkout.

Related Skills

Explore More Software Engineering Skills→
dotnetdotnet
20.6k

analyzer-codefix

Implement Roslyn analyzers, code fixes, and refactorings with testing patterns.

Official
Advanced
Greenmamba29Greenmamba29

docs-update

Scan code diffs and update Markdown documentation via pull requests.

Community
Intermediate
rjmurillorjmurillo
24

moq-analyzers-proof-toolkit

Validate Moq analyzers against Roslyn APIs version 4.8.0 using dotnet inspect and reflection.

Community
Advanced
ElbertePlinioElbertePlinio

wiki

Generate structured markdown wiki pages with Mermaid diagrams from codebases.

Community
Advanced