project-guidelines-example

Generate a project guideline template covering architecture, file structure, code patterns, testing, and deployment.

Updated Apr 30, 2026
One-click install
npx skills add https://github.com/Ced3-han/Harness-Settings --skill project-guidelines-example-ced3-han
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/Ced3-han/Harness-Settings/tree/main/skills/project-guidelines-example
Command: npx skills add https://github.com/Ced3-han/Harness-Settings --skill project-guidelines-example-ced3-han

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill offers a comprehensive project guideline template that helps in establishing clear architecture, file structure, coding patterns, testing, and deployment workflows.

Core Features & Use Cases

  • Project Architecture: Provides an overview of the project's technical stack, including frontend, backend, and AI integration.
  • File Structure: Details the recommended project folder and file organization for maintainability.
  • Code Patterns: Offers best practices for API responses, frontend API calls, Claude AI integration, and custom hooks.
  • Testing Requirements: Describes backend and frontend testing frameworks and commands for running tests.
  • Deployment Workflow: Guides through the pre-deployment checklist, deployment commands, and environment variables.
  • Critical Rules: Sets forth coding standards and best practices for development.
  • Related Skills: Cites other skills for further reference on coding standards, backend patterns, frontend patterns, and TDD.

Quick Start

Run the skill to get a detailed project guidelines template tailored for your project.

Frequently Asked Questions about project-guidelines-example

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

FAQPage Schema
How do I set up project guidelines for a Next.js and FastAPI tech stack?

To set up project guidelines for a Next.js and FastAPI stack, use a structured template that outlines architecture, file structure, code patterns, testing, and deployment practices. This streamlines workflows by establishing clear coding standards and technical stack integrations.

What should be included in software project architecture and file structure guidelines?

Software project architecture guidelines should include an overview of the technical stack, recommended folder organization for maintainability, API response patterns, and critical coding standards. These elements ensure streamlined development workflows and consistent project structure.

How do I integrate Claude API patterns into my project guidelines?

To integrate Claude API patterns into your project guidelines, include best practices for AI integration alongside frontend API calls and custom hooks. This provides a structured approach for embedding AI functionalities within your established software architecture.

Can I use this project guideline template with Supabase and Playwright?

Yes, the project guideline template supports frameworks and tools like Supabase and Playwright. It details backend and frontend testing frameworks, including commands for running tests, ensuring these technologies fit seamlessly into your deployment workflow.

What's the best way to document testing requirements and deployment workflows?

The best way to document testing and deployment is to use a comprehensive template describing testing frameworks, pre-deployment checklists, deployment commands, and environment variables. This establishes critical rules and standardized workflows for development teams.

Why do I need a structured project guideline template for software development?

You need a structured project guideline template to solve the problem of disorganized workflows and inconsistent coding practices. It delivers a standardized approach to architecture, file structure, and deployment, streamlining project workflows for software development teams.