skills.rest
vchelaru
vchelaruCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

skills-writer

Generate and update SKILL.md files from source code analysis.

597|79|Updated Mar 11, 2015
Search Tags:#automation#documentation#skills#reference#code-analysis#frontmatter
One-click install
npx skills add https://github.com/vchelaru/Gum --skill skills-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: skills-writer
Source: https://github.com/vchelaru/Gum/tree/main/.claude/skills/skills-writer
Command: npx skills add https://github.com/vchelaru/Gum --skill skills-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creates and updates Skill unit SKILL.md files by analyzing source code to produce concise, consistent documentation that can be loaded by Claude Code agents.

Core Features & Use Cases

  • Reads source files relevant to a skill topic and identifies structure and relationships.
  • Generates or updates SKILL.md frontmatter (name, description) and the Markdown body with activation instructions.
  • Ensures consistency with the Skill unit format across a repository, enabling rapid onboarding and automated documentation workflows.
  • Use Case: When adding a new skill directory, run this tool to generate its SKILL.md; when existing skills drift from style guidelines, re-run to refresh the docs.

Quick Start

Run the skills-writer tool on a repository to generate or refresh SKILL.md files for all skills.

Frequently Asked Questions about skills-writer

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

FAQPage Schema
How do I generate SKILL.md documentation from source code automatically?▼

Generate SKILL.md documentation from source code by analyzing the repository structure and deriving frontmatter, descriptions, and activation instructions to produce consistent Markdown files for Claude Code agents.

What is the best way to maintain consistent frontmatter across multiple skill directories?▼

Maintain consistent frontmatter across skill directories by applying a standardized schema to source files, ensuring fields like name and description align with the Skill unit format across the repository.

How do I update existing skill documentation when source code changes?▼

Update existing skill documentation when source code changes by re-running the documentation tool to refresh the SKILL.md files, reconciling drift from style guidelines and reflecting current code structure.

Can I use skills-writer to onboard new skills into a repository quickly?▼

Use skills-writer to onboard new skills into a repository by running the tool on a new skill directory to instantly generate its SKILL.md file with proper frontmatter and activation guidance.

Does generating skill docs require reading all source files in the repository?▼

Generating skill docs requires reading source files relevant to each skill topic to identify structure and relationships, focusing on files needed to construct accurate SKILL.md content rather than scanning the entire repository.

Related Skills

Explore More Software Engineering Skills→
jhlee0409jhlee0409
4

openapi-parser

Parse OpenAPI 3.x and Swagger 2.0 specs into structured endpoint catalogs.

Community
Advanced
mnsgrosamnsgrosa

code-generation-summarizer

Summarize per-file code changes and reasoning in structured documentation.

Community
Intermediate
auldsyababuaauldsyababua
6

markdown-validation

Validate Markdown files for syntax, links, and formatting standards.

Community
Advanced
Ditto190Ditto190

documentation-gen

Generate project documentation from templates and repository content.

Community
Basic