setting-up-docs

Generate environment setup documentation from codebase analysis.

11|1|Updated Aug 6, 2025
One-click install
npx skills add https://github.com/thkt/claude-config --skill setting-up-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: setting-up-docs
Source: https://github.com/thkt/claude-config/tree/main/ja/skills/setting-up-docs
Command: npx skills add https://github.com/thkt/claude-config --skill setting-up-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and assets (resource) components.

What problem does it solve?

コードベース分析に基づき、環境構築ガイドを自動生成します。パッケージマネージャ、ランタイム、環境変数、Docker設定、起動コマンドを体系的にまとめ、開発者の導入コストを大幅に削減します。

Core Features & Use Cases

  • 検出項目の自動抽出: Node/Python/Go等のランタイム、ツール、環境変数ファイルを検出。
  • テンプレート駆動生成: assets/setup-template.md に準拠したセットアップガイドを生成。
  • 起動・運用情報の整理: README/CI対応の起動コマンドを含む、実践的なセットアップ手順を提供。

Quick Start

/docs:setup もしくは "Setup environment for this project" の指示で、手動編集不要の環境ガイドが作成されます。

Frequently Asked Questions about setting-up-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate environment setup documentation for my project?

This Skill analyzes your codebase to automatically generate setup documentation. It detects package managers, runtime versions, environment variables, Docker configurations, and startup commands across Node.js, Python, Rust, Go, Java, and other ecosystems, outputting a ready-to-use Markdown guide without manual editing.

Can this detect environment variables and Docker configuration in my project?

Yes. The Skill scans for environment variable definitions, Dockerfile, docker-compose files, and .devcontainer configurations. It extracts these settings systematically and includes them in the generated setup guide alongside package manager and runtime detection.

What package managers and runtimes does the setup guide detection support?

The Skill detects package managers and runtimes across Node.js, Python, Rust, Go, Java, and other major ecosystems. It identifies the specific tools and versions your project requires, then documents them in a structured format for consistent team onboarding.

How do I generate a setup guide for my development environment?

Run the `/docs:setup` command or request 'Setup environment for this project.' The Skill analyzes your codebase, detects all configuration, dependencies, and startup commands, then generates a complete environment setup guide in Markdown format ready for documentation.

Does this work with containerized development environments?

Yes. The Skill detects and documents container configurations including Dockerfile, docker-compose, and .devcontainer files. It integrates these container setup details into the generated guide alongside traditional package manager and environment variable documentation.

What startup commands does the generated guide include?

The Skill extracts startup commands from your codebase and CI configuration, then includes them in the setup guide. This provides developers with practical, ready-to-run commands for initializing the development environment without manual discovery or trial-and-error.