skills.rest
jrodrigopuca
jrodrigopucaCOMMUNITY
Explore all skills by this author →
GitHub

create-development-guide

Generate development guides from repository evidence like scripts and Dockerfiles.

Updated Feb 10, 2026
Search Tags:#documentation#onboarding#build process#development guide#repository analysis#code setup
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill create-development-guide
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-development-guide
Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs/sub-skills/create-development-guide
Command: npx skills add https://github.com/jrodrigopuca/skills --skill create-development-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of comprehensive development guides for specific project scopes, ensuring all necessary setup, environment, execution, testing, linting, and build instructions are clearly documented based on repository evidence.

Core Features & Use Cases

  • Evidence-Based Documentation: Generates guides using only information found within the repository (scripts, Makefiles, Dockerfiles, CI configs).
  • Scope-Specific Guides: Tailors documentation to a selected {scope} and its boundaries.
  • Verification & Clarity: Clearly marks any unverified steps as "Needs confirmation" to avoid gaps.
  • Use Case: For a new developer joining a project, this Skill can generate a development-guide.md file within the project's docs/ directory, detailing exactly how to set up their local environment and run the necessary commands for a specific microservice or module.

Quick Start

Use the create-development-guide skill to generate a development guide for the 'api' scope.

Frequently Asked Questions about create-development-guide

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

FAQPage Schema
How do I generate a development guide for a specific project scope?▼

Generate a development guide by analyzing repository evidence like scripts, Makefiles, and Dockerfiles to document prerequisites, local setup, environment variables, run, test, lint, and build commands for a specified scope.

What is evidence-based onboarding documentation?▼

Evidence-based onboarding documentation creates development guides using only repository artifacts like CI configs and Dockerfiles, ensuring setup instructions are verified and clearly marking unverified steps as needing confirmation.

How to document local setup and build commands for a new developer?▼

Document local setup and build commands by analyzing repository scripts and Dockerfiles, which extracts environment variables and execution instructions to create a comprehensive onboarding guide for new developers joining a project.

Does the development guide generation work without external dependencies?▼

Yes, guide generation works without external dependencies, relying entirely on explicit repository evidence to document operational notes and common issues while marking any unverified information as needing confirmation.

What's the best way to automate code setup documentation for a microservice?▼

Automate code setup documentation by generating a scope-specific development guide that analyzes repository evidence to detail exactly how to configure the local environment and run necessary commands for a specific microservice or module.

How does it handle missing or unverified steps in the repository?▼

It handles unverified steps by explicitly marking them as needing confirmation in the generated development guide, ensuring gaps are visible and avoiding incorrect setup instructions when explicit repository evidence is missing.

Related Skills

Explore More Software Engineering Skills→
Open330Open330
1

preparing-iac-deployment

Analyze projects to generate Dockerfiles, Kubernetes manifests, and CI/CD workflows.

Official
Advanced
HouseofmvpsHouseofmvps
115

onboard

Generates structured onboarding documentation with Mermaid diagrams from scanned codebase metadata.

Community
Intermediate
rodmena-limitedrodmena-limited
3

moai-foundation-claude

Create, configure, and manage Claude Code Skills with templates and tools.

Official
Advanced
thktthkt
11

documenting-setup

Generate environment setup guide documentation from codebase analysis.

Community
Intermediate