How do I trigger the documentation generation?

You can use the specific command /docs:setup or simply ask Claude in natural language to 'Generate an environment setup guide' while in your project directory.

Which programming languages does this skill support?

It supports a wide range of ecosystems including JavaScript/Node.js, Python, Ruby, Rust, Go, Java, PHP, and Dart by scanning for their respective package managers and lock files.

Can it detect secret environment variables?

The skill identifies necessary environment variables by analyzing template files like .env.example or .env.sample, ensuring that your documentation lists required keys without exposing actual secrets.

Does it include Docker instructions?

Yes, if your project contains a Dockerfile, docker-compose.yml, or .devcontainer folder, the skill will automatically include a dedicated section for running the project with containers.

Environment Setup Documentation

Name: Environment Setup Documentation
Author: thkt

bythkt

•

Learning & Documentation

Generates comprehensive environment setup and installation guides by automatically analyzing your project's codebase and configuration files.

The setting-up-docs skill automates the creation of developer onboarding documentation by scanning your repository for package managers, runtime versions, environment variables, and startup commands. It identifies technologies such as Docker, Node.js, Python, Rust, and Go to produce a standardized Markdown guide, ensuring that contributors and new team members can get projects running quickly with accurate, codebase-derived instructions instead of outdated manual docs.

Key Features

01Detection of containerization tools including Docker and Dev Containers

023 GitHub stars

03Identification of required environment variables from .env.example and template files

04Automatic detection of package managers and runtime versions across multiple languages

05Extraction of startup, build, and test commands from scripts and Makefiles

06Standardized Markdown output for consistent and professional project documentation

Use Cases

01Onboarding new developers to a legacy codebase without existing documentation

02Synchronizing installation instructions across multiple microservices in a monorepo

03Quickly generating a standardized 'Getting Started' guide for new projects

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thkt/claude-config setting-up-docs

For use in Claude.ai and ChatGPT

Download Skill