cc-skill-project-guidelines-example

The Project Guidelines Skill serves as a foundational template for embedding domain-specific engineering standards into AI coding agents. It enables developers to document the essential architecture, tech stack, and conventions of a project, ensuring that an agent acts as a deterministic assistant rather than a source of hallucinated code. This skill is specifically designed for complex production environments, such as those leveraging Next.js, FastAPI, Supabase, and Claude API. By providing clear guidance on file structures, API response formats, and testing requirements, it helps teams maintain consistency across large-scale software projects.

• Encapsulates architecture overviews, including frontend and backend service communication patterns.

• Standardizes code patterns like API response wrappers, React hooks for state management, and structured AI tool usage.

• Defines file structure conventions, such as routing logic, component organization, and utility placement.

• Embeds testing requirements, including requirements for Playwright, pytest, and integration tests to ensure code verification.

• Provides a robust framework for documenting deployment workflows and configuration management.

• Ideal for team leads and architects managing complex agentic workflows in production environments.

• Useful for onboarding new developers or setting up automated coding assistants with specific organizational knowledge.

• Inputs include your specific project structure and guidelines, while outputs provide the agent with a 'source of truth' to guide its code generation.

• Constraints: Best results are achieved when local documentation is kept in sync with the repository; relies on strict adherence to the defined architecture to prevent drift. Recommended for use alongside other specialized agent kits to ensure comprehensive coverage of project domains and operational requirements.