How does the README skill know my project structure?

The skill analyzes the current folder contents and subdirectories to create an accurate visual representation of your project's hierarchy.

Will it format my code snippets automatically?

The skill includes an automated linting step using /md-lint to ensure all markdown and code blocks are properly formatted and valid.

Can I use this for files other than README.md?

Yes, you can provide a target file path as an argument to generate any form of markdown documentation.

Does it follow specific writing styles?

Yes, it integrates with the /md-syntax and /md-style skills to ensure all generated content follows best practices for technical writing.

README & Documentation Generator

Name: README & Documentation Generator
Author: jimweller

byjimweller

0•

Aprendizaje y Documentación

Generates comprehensive project documentation and README files based on conversation context and directory structure.

The README skill streamlines the creation of high-quality project documentation by analyzing both the conversation history and the physical structure of your codebase. It follows strict markdown conventions and styling rules to ensure consistency, producing structured outlines that include architecture overviews, project hierarchies, prerequisites, and installation guides. This skill is particularly useful for developers looking to automate the tedious task of documenting complex repositories while ensuring technical accuracy and professional formatting across all project folders.

Características Principales

01Context-aware documentation generation using conversation history

02Enforcement of standardized markdown syntax and styling rules

03Template-driven outlines for architecture, usage, and installation

04Automatic folder structure visualization for project maps

05Integrated linting and formatting via /md-lint

060 GitHub stars

Casos de Uso

01Quickly bootstrapping professional README files for new software projects

02Generating consistent documentation for sub-modules in a monorepo

03Updating technical guides and prerequisites after architectural changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles readme

For use in Claude.ai and ChatGPT

Características Principales

01Context-aware documentation generation using conversation history

02Enforcement of standardized markdown syntax and styling rules

03Template-driven outlines for architecture, usage, and installation

04Automatic folder structure visualization for project maps

05Integrated linting and formatting via /md-lint

060 GitHub stars

Casos de Uso

01Quickly bootstrapping professional README files for new software projects

02Generating consistent documentation for sub-modules in a monorepo

03Updating technical guides and prerequisites after architectural changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimweller/davit-dataops-dotfiles readme

For use in Claude.ai and ChatGPT