How does this skill determine the project structure?

The skill analyzes the contents of the target folder and its subdirectories to create a visual tree of the project architecture automatically.

Does it follow documentation best practices?

Absolutely. It utilizes specific sub-skills for Markdown syntax and style conventions, then runs a linting process to ensure the output is professional and error-free.

Does it require manual input for the content?

It leverages your conversation history and existing folder contents to infer the purpose of the code, though you can provide additional guidance as arguments.

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

Yes, while it defaults to README.md, you can pass a custom file path as an argument to generate any Markdown-based documentation.

Smart README Generator

Name: Smart README Generator
Author: jimweller

byjimweller

0•

Learning & Documentation

Generates structured Markdown documentation by analyzing conversation history, project folder contents, and architectural context.

The README skill automates the creation of high-quality project documentation by synthesizing your current chat context with your file system's structure. It goes beyond basic templates by identifying project components, prerequisites, and installation steps directly from your environment. By integrating specialized sub-skills for Markdown syntax, styling, and linting, it ensures that every generated document adheres to professional authoring conventions and technical standards, making it an essential tool for maintaining up-to-date repository guides with minimal effort.

Key Features

01Contextual documentation generation based on conversation history

02Automatic project tree mapping for architectural overviews

03Integrated Markdown syntax and style enforcement

04Built-in linting to ensure clean, valid documentation

05Standardized templates for prerequisites, installation, and usage

060 GitHub stars

Use Cases

01Bootstrapping a professional README.md for a new open-source repository

02Creating detailed sub-folder documentation for modular monorepos

03Documenting complex installation and build steps from project context

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

Key Features

01Contextual documentation generation based on conversation history

02Automatic project tree mapping for architectural overviews

03Integrated Markdown syntax and style enforcement

04Built-in linting to ensure clean, valid documentation

05Standardized templates for prerequisites, installation, and usage

060 GitHub stars

Use Cases

01Bootstrapping a professional README.md for a new open-source repository

02Creating detailed sub-folder documentation for modular monorepos

03Documenting complex installation and build steps from project context

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