skills.rest
discountry
discountryCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document

Generate codebase-aligned README, integration guides, and tutorials from repository analysis.

1|Updated Mar 12, 2026
Search Tags:#documentation#codebase#technical writing#readme#subagent#repo analysis#project guides
One-click install
npx skills add https://github.com/discountry/ritmex-skills --skill document-discountry
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/discountry/ritmex-skills/tree/main/skills/document
Command: npx skills add https://github.com/discountry/ritmex-skills --skill document-discountry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually writing project documentation that does not match the actual state of your codebase is time-consuming and often leads to outdated, incorrect guides that confuse users and contributors.

Core Features & Use Cases

  • Subagent-Powered Analysis: Spawns a dedicated subagent to thoroughly scan your repository for accurate setup, configuration, and usage details.
  • Multi-Format Doc Generation: Creates standard project documentation including README files, integration guides, tutorials, product docs, FAQ, and troubleshooting content.
  • Use Case: You just finished building a new open source tool and need a complete README with correct install steps, usage examples, and contribution guidelines that match your actual codebase, no guesswork required.

Quick Start

Ask the AI to generate a complete, up-to-date README.md for your current repository using the document skill.

Frequently Asked Questions about document

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

FAQPage Schema
How do I generate a README that matches my actual codebase?▼

To generate a README that matches your actual codebase, this skill spawns a dedicated subagent to analyze your repository contents and produces accurate setup steps, commands, and configuration details grounded in real repo files.

What is the best way to write integration guides from an existing repository?▼

The best way to write integration guides from an existing repository is using a subagent-powered analysis to thoroughly scan your repo, ensuring all configuration details and usage examples are grounded in actual files.

Can I create tutorials and troubleshooting docs for software projects of any size?▼

Yes, you can create tutorials and troubleshooting docs for software projects of any size by spawning a dedicated subagent to analyze repository contents and generate codebase-aligned documentation.

How does subagent-powered repo analysis prevent outdated project documentation?▼

Subagent-powered repo analysis prevents outdated project documentation by thoroughly scanning your repository to ground all setup steps, commands, and configuration details in actual repo files, eliminating speculative content.

Do I need any dependencies to generate project docs from my codebase?▼

No, you do not need any dependencies to generate project docs from your codebase. The skill operates independently to spawn a subagent that analyzes your repository contents and produces accurate documentation.

Related Skills

Explore More Software Engineering Skills→
twlinestwlines

document

Generates structured Markdown documentation for Effect-TS code files and services.

Community
Intermediate
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
phraphra

code-review

Review modified code files and auto-fix mechanical issues.

Community
Advanced
spideynolovespideynolove
2

api-documentation-generator

Generate OpenAPI specs and endpoint documentation from source code.

Community
Advanced