How does the skill know what to write?

The skill analyzes your current directory structure and uses your conversation history to understand the project's purpose and functionality.

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

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

Does it follow specific Markdown standards?

Yes, it integrates with specialized syntax and style skills to ensure your documentation follows best practices and is properly linted.

Will it document my entire hard drive?

No, the skill is restricted to analyzing files at the specified directory level and below, ensuring it only documents the relevant project.

README & Documentation Architect

Name: README & Documentation Architect
Author: jimweller

byjimweller

0•

Learning & Documentation

Generates structured, professional Markdown documentation by analyzing repository contents and conversation history.

The README & Documentation Architect skill automates the process of creating high-quality project documentation by synthesizing information from your repository's folder structure and active chat context. It provides a standardized framework for building README files—including architecture overviews, visual project structures, and installation guides—while ensuring consistency through integrated markdown styling and linting rules. This tool is ideal for developers who want to maintain clear, professional documentation with minimal manual effort.

Key Features

01Automated README generation from repository metadata

02Context-aware documentation based on chat history

03Standardized project structure visualization

04Integrated Markdown syntax and style validation

05Customizable templates for architecture and usage guides

060 GitHub stars

Use Cases

01Updating technical guides after significant architectural changes

02Bootstrapping professional documentation for new software projects

03Standardizing README structures across multiple 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

Key Features

01Automated README generation from repository metadata

02Context-aware documentation based on chat history

03Standardized project structure visualization

04Integrated Markdown syntax and style validation

05Customizable templates for architecture and usage guides

060 GitHub stars

Use Cases

01Updating technical guides after significant architectural changes

02Bootstrapping professional documentation for new software projects

03Standardizing README structures across multiple 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