Project Guidelines Skill (Example)

Provide project-specific development guidelines covering architecture, file structure, code patterns, testing, and deployment workflows.

Updated Feb 21, 2026
One-click install
npx skills add https://github.com/AndyHsuTW/everything-llm-workspace --skill project-guidelines-skill-example-andyhsutw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Project Guidelines Skill (Example)
Source: https://github.com/AndyHsuTW/everything-llm-workspace/tree/main/.agents/skills/project-guidelines-example
Command: npx skills add https://github.com/AndyHsuTW/everything-llm-workspace --skill project-guidelines-skill-example-andyhsutw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a centralized, easily accessible reference for project-specific development guidelines, ensuring consistency and adherence to best practices across the team.

Core Features & Use Cases

  • Architecture Overview: Details the technology stack, services, and deployment strategy.
  • File Structure: Outlines the expected organization of project files and directories.
  • Code Patterns: Provides examples of common API response formats, frontend calls, AI integrations, and custom hooks.
  • Testing Requirements: Specifies testing methodologies and example structures for both backend and frontend.
  • Deployment Workflow: Guides through pre-deployment checks and deployment commands.
  • Critical Rules: Lists non-negotiable coding standards and practices.
  • Use Case: A new developer joins the project and needs to understand the established patterns for API communication and testing. They can quickly reference this Skill to get up to speed.

Quick Start

Refer to the project guidelines skill for the backend API response format.

Frequently Asked Questions about Project Guidelines Skill (Example)

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

FAQPage Schema
How do I establish development standards for a new software project?

To establish development standards, you need centralized project guidelines that define architecture, file structure, code patterns, and critical coding rules. This ensures consistency and adherence to best practices across the entire development team.

What should be included in project guidelines for developer onboarding?

Project guidelines for onboarding should include an architecture overview, expected file structure, common code patterns for API responses, testing requirements, and deployment workflows. This helps new developers quickly understand established project patterns.

How do I enforce consistent code patterns and testing methodologies across a team?

You can enforce consistent code patterns and testing methodologies by referencing a centralized guideline that specifies critical rules, example structures for backend and frontend tests, and non-negotiable coding standards within the project context.

What is the best way to document deployment workflows and pre-deployment checks?

The best way to document deployment workflows is to create a comprehensive reference outlining pre-deployment checks and exact deployment commands. This maintains consistency and prevents errors during the release process.

Can I use a single reference for both frontend and backend development standards?

Yes, you can use a single reference to cover both frontend and backend standards. It should provide examples of common API response formats, frontend calls, custom hooks, and specific testing methodologies for both sides.

When do I need to define critical coding rules in project guidelines?

You need to define critical coding rules in project guidelines whenever a project requires strict adherence to best practices. Listing non-negotiable standards prevents inconsistent implementations and maintains codebase quality.