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

Yes, you can provide any target file path as the first argument to generate structured markdown content for other documentation needs.

How does the skill know what to write?

It analyzes the current conversation history for context and scans the folder contents at your specified directory level to understand the project structure.

Does it support markdown formatting standards?

Absolutely. It uses dedicated sub-skills for markdown syntax and style, and automatically runs a linting process to ensure clean, standard output.

Will it scan parent directories?

No, for security and focus, the skill only analyzes folder contents at the specified file argument level and its subfolders, never parents.

README Documentation Architect

Name: README Documentation Architect
Author: jimweller

byjimweller

0•

Content Management

Generates comprehensive project documentation and README files by analyzing conversation context and directory structures.

This skill automates the creation of high-quality project documentation by synthesizing conversation history and folder contents into structured Markdown files. It enforces best practices through specialized syntax and style sub-skills, providing a standardized template that covers architecture, installation, usage, and project structure. By analyzing both the files present and the developer's previous instructions, it ensures that project repositories remain well-documented and professional with minimal manual effort.

Key Features

01Integrated markdown linting and style enforcement

020 GitHub stars

03Context-aware documentation generation from chat history

04Support for custom file paths and specific documentation guidance

05Automatic directory mapping for project structure sections

06Standardized templates for README.md architecture and usage

Use Cases

01Bootstrapping professional documentation for a new repository

02Updating existing READMEs to reflect recent architectural changes

03Standardizing documentation across a suite of microservices

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

01Integrated markdown linting and style enforcement

020 GitHub stars

03Context-aware documentation generation from chat history

04Support for custom file paths and specific documentation guidance

05Automatic directory mapping for project structure sections

06Standardized templates for README.md architecture and usage

Use Cases

01Bootstrapping professional documentation for a new repository

02Updating existing READMEs to reflect recent architectural changes

03Standardizing documentation across a suite of microservices

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