readme

Generate markdown documentation from conversation history and directory contents.

2|Updated Feb 14, 2026

Search Tags:#documentation #markdown #project structure #code generation #readme #contextual writing

Ready to run

npx skills add https://github.com/jimweller/davit-dataops-dotfiles --skill readme-jimweller

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/jimweller/davit-dataops-dotfiles/tree/main/claude-code/skills/readme
Command: npx skills add https://github.com/jimweller/davit-dataops-dotfiles --skill readme-jimweller

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of markdown documentation by leveraging conversation history and the contents of a specified directory, streamlining the documentation process.

Core Features & Use Cases

Contextual Documentation: Generates markdown content based on current conversation and folder structure.
File Path Targeting: Allows specifying a target file (defaults to README.md) and considers folder contents at that level and below.
Use Case: After developing a new feature, use this Skill to quickly generate a comprehensive README.md for the project, including sections on architecture, project structure, prerequisites, and usage, based on your recent development discussions and the project's file layout.

Quick Start

Use the readme skill to generate a README.md file in the current directory.

Frequently Asked Questions about readme

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

FAQPage Schema

How do I generate a project README from existing code and conversation history?▼

To generate a project README, this Skill uses your conversation history and recursively processes specified directory contents to produce contextual markdown documentation covering architecture, project structure, and usage.

Can I generate markdown documentation for specific files instead of the whole project?▼

Yes, you can generate markdown documentation for specific files by specifying a target file path. The Skill defaults to creating a README.md but processes folder contents at the targeted level and below.

What is the best way to document a new feature after development discussions?▼

The best way to document a new feature is to use this Skill immediately after development discussions. It leverages your conversation context and the project's file layout to automatically write comprehensive markdown overviews.

Does this documentation generator work for API documentation and module overviews?▼

Yes, this documentation generator works for API documentation and module overviews. It analyzes your conversation history and sibling folder contents to produce structured markdown documentation.

What sections are included when generating markdown documentation from a directory?▼

When generating markdown documentation from a directory, the output includes sections on project architecture, project structure, prerequisites, and usage based on the processed folder contents and conversation context.

Do I need any dependencies to generate markdown documentation from conversation context?▼

No dependencies are required to generate markdown documentation from conversation context. The Skill operates independently to analyze your project structure and produce markdown files.