How does this skill know what to include in the README?

It analyzes your current conversation history and the file/folder structure of your project to identify architecture, dependencies, and usage patterns.

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

Yes, you can specify any target file path as the first argument when invoking the skill to create specialized documentation like INSTALL.md or API.md.

Does it follow specific documentation styles?

Yes, it utilizes specific sub-skills for markdown syntax, styling conventions, and linting to ensure high-quality, professional output.

Does it include a directory map?

Yes, it is designed to automatically generate a visual representation of your folder structure to explain the project layout clearly.

Documentation Architect

Name: Documentation Architect
Author: jimweller

byjimweller

0•

Aprendizaje y Documentación

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

This skill automates the creation of high-quality project documentation by analyzing local folder structures, codebase architecture, and recent development history. It ensures professional standards by integrating with markdown syntax, style, and linting rules, providing a structured template that covers architecture, prerequisites, installation, and usage details to streamline developer onboarding for any project.

Características Principales

010 GitHub stars

02Automatically maps project folder hierarchies for architecture sections

03Integrates with Markdown syntax and style conventions

04Generates structured README.md files from conversation history

05Supports custom documentation file paths beyond the default README

06Includes built-in linting and formatting for clean, professional output

Casos de Uso

01Rapidly documenting a new repository before the first commit

02Updating existing project documentation based on recent code changes and feature discussions

03Standardizing documentation across multiple microservices or monorepo components

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

010 GitHub stars

02Automatically maps project folder hierarchies for architecture sections

03Integrates with Markdown syntax and style conventions

04Generates structured README.md files from conversation history

05Supports custom documentation file paths beyond the default README

06Includes built-in linting and formatting for clean, professional output

Casos de Uso

01Rapidly documenting a new repository before the first commit

02Updating existing project documentation based on recent code changes and feature discussions

03Standardizing documentation across multiple microservices or monorepo components

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