Does it include the directory structure automatically?

Yes, the skill is designed to analyze sibling and subfolder contents to create an accurate visual representation of your project's architecture.

How does it handle markdown formatting?

The skill utilizes specific markdown syntax and style rules during the writing process and automatically runs a linter afterward to ensure the file is correctly formatted.

Does it look at parent directories for context?

No, for security and focus, the skill only analyzes contents at the specified argument level and below, never looking at parent directories.

Can I generate files other than README.md?

Yes, while it defaults to README.md, you can provide any file path as an argument to generate documentation for specific modules or subfolders.

README Documentation Generator

Name: README Documentation Generator
Author: jimweller

byjimweller

0•

콘텐츠 관리

Generates comprehensive markdown documentation by analyzing directory structures and conversation history.

The README skill automates the creation of professional project documentation by synthesizing folder contents and conversation context into structured markdown. It streamlines the technical writing process by generating architecture overviews, project hierarchies, and usage instructions while ensuring adherence to specific markdown syntax and styling conventions. By integrating automated linting and formatting, it helps developers maintain high-quality, consistent documentation across any project or sub-directory with minimal effort.

주요 기능

01Automatic folder structure mapping for project hierarchies

02Context-aware content generation from conversation history

03Support for custom target file paths and specific writing guidance

04Post-generation linting for clean and consistent formatting

05Integrated markdown syntax and style rule enforcement

060 GitHub stars

사용 사례

01Updating existing documentation based on recent development discussions

02Documenting complex sub-services within a monorepo architecture

03Bootstrapping a standardized README.md for new repositories

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

Download Skill