Where does the output go?

The skill generates a structured Markdown document based on a template, which can be saved directly to your repository as a README or SETUP.md.

Can it identify required environment variables?

Yes, it scans for .env.example, .env.sample, and .env.template files to list all necessary variables and their purposes.

Does it support Docker-based environments?

Absolutely. It detects Dockerfiles, docker-compose.yml, and .devcontainer configurations to include container-specific setup steps.

What languages and frameworks does this skill support?

It supports a wide range of ecosystems including Node.js, Python, Rust, Go, Flutter, Ruby, and Java by detecting their specific configuration and lock files.

How do I trigger the documentation generation?

You can trigger it using natural language like 'generate a setup guide' or by using the specific command /docs:setup.

Setup Documentation Architect

Name: Setup Documentation Architect
Author: thkt

bythkt

•

学习与文档

Generates comprehensive environment setup guides by automatically analyzing codebase dependencies, package managers, and configuration files.

关于

The Setup Documentation Architect skill automates the creation of professional 'Getting Started' documentation for software projects. By scanning a repository for package manager lockfiles, runtime version managers, environment variable templates, and Docker configurations, it builds a structured Markdown guide tailored to the specific stack. This skill is indispensable for onboarding new developers, standardizing documentation across teams, and ensuring that local development instructions are always synchronized with the actual codebase requirements.

主要功能

Identification of startup, build, and test commands from scripts and Makefiles
Automated environment variable extraction from .env.example and template files
3 GitHub stars
Runtime version sensing via .nvmrc, .python-version, and asdf tool-versions
Automatic detection of package managers across Node.js, Python, Rust, Go, Flutter, and more
Detection of containerization workflows including Docker and Dev Containers

使用场景

Standardizing README files and setup guides across multiple microservices
Updating legacy documentation to reflect modern package managers and tool versions
Rapidly onboarding new team members with accurate, automated local setup instructions

关于

主要功能

Identification of startup, build, and test commands from scripts and Makefiles
Automated environment variable extraction from .env.example and template files
3 GitHub stars
Runtime version sensing via .nvmrc, .python-version, and asdf tool-versions
Automatic detection of package managers across Node.js, Python, Rust, Go, Flutter, and more
Detection of containerization workflows including Docker and Dev Containers

使用场景

Standardizing README files and setup guides across multiple microservices
Updating legacy documentation to reflect modern package managers and tool versions
Rapidly onboarding new team members with accurate, automated local setup instructions