docs

Generate and maintain README, API, and changelog files from code changes.

82|23|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/Rune-kit/rune --skill docs-rune-kit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Rune-kit/rune/tree/main/skills/docs
Command: npx skills add https://github.com/Rune-kit/rune --skill docs-rune-kit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and maintenance of project documentation, ensuring that your READMEs, API references, and changelogs are always up-to-date with your codebase.

Core Features & Use Cases

  • Automated Documentation Generation: Creates initial README, ARCHITECTURE.md, and API.md files.
  • Real-time Syncing: Updates documentation automatically to reflect code changes.
  • Changelog Management: Generates changelog entries from git history.
  • Use Case: After implementing a new API endpoint, this skill automatically updates the API.md file and adds a note to the changelog, so your documentation is never outdated.

Quick Start

Use the docs skill to initialize documentation for your new project.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I automatically generate README and API documentation for my project?

Automatically generate README and API documentation by initializing the docs skill, which creates initial README, ARCHITECTURE.md, and API.md files based on your codebase structure.

Can I keep project documentation in sync with code changes automatically?

Yes, you can keep documentation in sync with code changes automatically. The skill performs incremental updates to your docs whenever your codebase changes, ensuring files never become outdated.

How do I generate a changelog from git history for my software project?

Generate a changelog from git history by integrating the docs skill with your repository. It parses commit history to automatically create and manage changelog entries for your software project.

Does the documentation generator work with route definitions to create API references?

Yes, the documentation generator works with route definitions to create API references. It scans your code to extract route definitions and compiles them directly into an API.md file.

What is the best way to maintain API documentation without manual updates?

The best way to maintain API documentation without manual updates is using an automated syncing tool. This skill updates your API references and changelogs automatically whenever new endpoints are implemented.

Do I need any specific dependencies to automate my project documentation lifecycle?

No external dependencies are required to automate your project documentation lifecycle. The skill operates independently using internal scripts and integrates with git for changelogs and scout for code scanning.