project-guidelines-example

Document architecture, code patterns, testing, and deployment for fullstack applications.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/gugug168/claudecode-tutorial --skill project-guidelines-example-gugug168
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/gugug168/claudecode-tutorial/tree/main/everything-claude-code-learning/02-Skills/project-guidelines-example
Command: npx skills add https://github.com/gugug168/claudecode-tutorial --skill project-guidelines-example-gugug168

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a single-source project handbook that reduces onboarding friction, enforces consistent architecture and coding patterns, and documents testing and deployment steps so teams avoid ad-hoc decisions and repeated onboarding questions.

Core Features & Use Cases

  • Architecture Overview: Summarizes the stack and service interactions (Next.js frontend, FastAPI backend, Supabase DB, Claude AI integrations, Redis cache).
  • File Structure & Code Patterns: Specifies directory layout, API response schemas, frontend hooks, and recommended import/naming conventions.
  • Testing & Deployment Guidance: Lists commands and checklists for pytest, Playwright, build steps, and Cloud Run deployment to ensure reliable releases.
  • Use Case: Onboard a new engineer or run a consistent release by following the documented checklist and patterns to avoid environment drift.

Quick Start

Copy this SKILL.md into your project, update the architecture, file structure, code patterns, tests, and deployment checklist to match your repository.

Frequently Asked Questions about project-guidelines-example

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

FAQPage Schema
How do I create project-specific development guidelines for a fullstack Next.js and FastAPI team?

To create development guidelines for a fullstack Next.js and FastAPI team, you need to document architecture overviews, file structures, coding patterns, test commands, and deployment checklists. This provides a single-source project handbook that reduces onboarding friction and enforces consistent architecture.

What should a team onboarding checklist include for a Supabase and Next.js application?

A team onboarding checklist for a Supabase and Next.js application should include architecture overviews, directory layouts, API response schemas, frontend hooks, and environment variable requirements. Documenting these elements prevents ad-hoc decisions and ensures consistent team onboarding.

How do I document testing and deployment steps for a FastAPI and Next.js codebase?

To document testing and deployment for a FastAPI and Next.js codebase, specify commands and checklists for pytest, Playwright, build steps, and Cloud Run deployment. This ensures reliable releases and helps teams avoid environment drift during automation.

Does this project guidelines template work with Redis cache and Claude AI integrations?

Yes, this project guidelines template works with Redis cache and Claude AI integrations by summarizing service interactions within the architecture overview. It supports fullstack applications using Next.js, FastAPI, and Supabase.

What is the best way to standardize coding patterns and file structures across a fullstack engineering team?

The best way to standardize coding patterns and file structures is to maintain a single-source project handbook specifying directory layouts, API schemas, recommended import conventions, and frontend hooks. This approach enforces consistent architecture and avoids repeated onboarding questions.

Why do fullstack teams need documented environment variable requirements and deployment checklists?

Fullstack teams need documented environment variable requirements and deployment checklists to avoid environment drift and ensure reliable releases. Documenting these steps provides a consistent project handbook that reduces onboarding friction and ad-hoc decisions.