skills.rest
spaarke-dev
spaarke-devCOMMUNITY
Explore all skills by this author →
GitHub

project-setup

Generate README.md, plan.md, CLAUDE.md, and a standardized folder structure from a design specification.

1|1|Updated Sep 25, 2025
Search Tags:#automation#readme#plan#project-setup#claude-md#artifact-generation#spec-md
One-click install
npx skills add https://github.com/spaarke-dev/spaarke --skill project-setup-spaarke-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-setup
Source: https://github.com/spaarke-dev/spaarke/tree/main/.claude/skills/project-setup
Command: npx skills add https://github.com/spaarke-dev/spaarke --skill project-setup-spaarke-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill generates foundational project artifacts from a design specification, eliminating manual scaffolding tasks.

Core Features & Use Cases

  • Generates README.md, PLAN.md, and CLAUDE.md from a design spec to jump-start projects.
  • Creates a standardized folder structure (tasks/ and notes/) to support consistent project bootstrapping.
  • Deterministic: given the same spec, it produces identical artifacts; zero side effects or external changes.
  • Integrates with project-pipeline to streamline the end-to-end setup.

Quick Start

  1. Ensure a design specification exists at projects/{project-name}/spec.md
  2. Run the orchestrator: /project-setup projects/{project-name}
  3. Review the generated artifacts: README.md, plan.md, CLAUDE.md, and the project folder structure

Frequently Asked Questions about project-setup

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

FAQPage Schema
How do I generate README and project documentation from a design spec?▼

You can generate README.md, plan.md, and CLAUDE.md from a design specification by running a project bootstrapping command. This process reads the spec.md file and automatically outputs the foundational project artifacts and a standardized folder structure.

What's the best way to scaffold a new project folder structure automatically?▼

Automating project scaffolding from a design specification creates a standardized folder structure including tasks/ and notes/ directories. This deterministic approach generates identical artifacts every time, eliminating manual setup and ensuring consistent project bootstrapping.

Can I generate consistent project artifacts across multiple new projects?▼

Yes, generating project artifacts from a design spec is a deterministic process. Given the same specification, it produces identical README.md, plan.md, and CLAUDE.md files with zero side effects, ensuring consistent initialization across multiple projects.

Do I need a spec.md file to start project bootstrapping?▼

Yes, project bootstrapping requires a design specification to exist at projects/{project-name}/spec.md. This file serves as the input for generating the README.md, plan.md, CLAUDE.md, and the standardized folder structure.

How does artifact generation integrate with a project pipeline workflow?▼

Artifact generation integrates with project-pipeline workflows to streamline end-to-end project setup. By initializing new projects within this pipeline, it creates the necessary foundational files and folders to support subsequent development steps.

What files are created when initializing a new project from a design spec?▼

Initializing a new project from a design specification creates README.md, plan.md, and CLAUDE.md files. It also generates a standardized folder structure with tasks/ and notes/ directories to support consistent project organization.

Related Skills

Explore More Software Engineering Skills→
telihateliha

generate-spec

Generate specification files from requirements into specs/[feature-name]/spec.md.

Official
Intermediate
imehrimehr

dev-docs-workflow

Maintains three-file task documentation (plan.md, context.md, tasks.md) for Claude Code sessions.

Community
Basic
yamato0811yamato0811

repository-structure

Define a templated repository structure for software projects.

Community
Basic
georgeguigeorgegui

visualize-project

Generate interactive Directed Acyclic Graphs from project structures and documentation.

Community
Advanced