code-documentation

Automates updates and creation of Markdown documentation files across a project.

1|Updated May 22, 2020
One-click install
npx skills add https://github.com/rolspace/blazor-football-scoreboard --skill code-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/rolspace/blazor-football-scoreboard/tree/main/.claude/skills/code-documentation
Command: npx skills add https://github.com/rolspace/blazor-football-scoreboard --skill code-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the updating and creation of Markdown documentation across a project (README, docs, architecture docs) when requested, preserving formatting and style.

Core Features & Use Cases

  • Documentation Discovery: Locate Markdown files across common locations such as the project root README.md, /docs, and /src/Hosts/*/README.md.
  • Content Analysis & Update: Read existing docs, apply requested updates, and preserve existing formatting and style.
  • Documentation Creation: Create new Markdown files when documentation is missing or needs to be added.
  • Use Case: If you need to document a new API endpoint, this Skill can update the relevant README.md to reflect the change and keep docs consistent.

Quick Start

Update the project's README to include the new API endpoint and run the Skill to apply changes to the Markdown files.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I automatically update my project README when code changes?

This Skill automates Markdown documentation updates across your project. It locates README.md, CLAUDE.md, CONTRIBUTING.md, /docs, and /src/Hosts/*/README.md files, reads existing content, applies your requested changes while preserving formatting and structure, and writes updates back to keep docs in sync with your codebase.

Can I use Glob patterns to find and update multiple Markdown files at once?

Yes. The Skill uses Glob to discover Markdown files across standard project locations, then applies edits consistently across matched files. This lets you update documentation hierarchy and structure in one operation without manually locating each file.

What Markdown documentation locations does this Skill cover?

The Skill handles project root README.md, CLAUDE.md, CONTRIBUTING.md, the /docs directory, and per-application documentation under /src/Hosts/*/README.md. It preserves Markdown formatting, headers, and code blocks while applying updates to any of these locations.

How do I add new API endpoint documentation to an existing README?

Describe the documentation change you need—such as adding an endpoint to your README. The Skill reads your current README, applies the requested modification while maintaining existing formatting and project style, and writes the updated file back to preserve consistency.

Does this Skill preserve existing documentation formatting and style?

Yes. The Skill enforces Markdown formatting with proper headers and code blocks while preserving your existing documentation hierarchy, structure, and project-specific style conventions throughout all updates.