Create Steering Documents

Create comprehensive steering documents for a development project based on the project type and requirements.

Usage

Create steering documents for [project description]

Examples

• Create steering documents for a React TypeScript e-commerce application
• Create steering documents for a Python Django REST API with PostgreSQL
• Create steering documents for a Node.js microservices architecture
• Create steering documents for a Vue.js component library

What Are Steering Documents?

Steering documents are contextual guidelines that influence how AI assistants approach development tasks. They contain project-specific standards, conventions, and best practices that help provide more relevant and consistent assistance.

How They Work

1. Always Included (Default): Documents without front-matter are included in every interaction
2. File Match Conditional: Documents with inclusion: fileMatch are included when specific files are in context
3. Manual Inclusion: Documents with inclusion: manual are only included when explicitly referenced

Process

1. Project Analysis

First, analyze the project requirements and determine which steering documents are needed:

For Frontend Projects (React, Vue, Angular):

• Include: project-standards.md, git-workflow.md, frontend-standards.md, development-environment.md
• Consider: component-library.md, testing-strategy.md

For Backend/API Projects (Node.js, Python, Java):

• Include: project-standards.md, git-workflow.md, api-design.md, development-environment.md
• Consider: database-standards.md, security-guidelines.md

For Full-Stack Projects:

• Include: All core documents plus technology-specific ones
• Consider: deployment-standards.md, monitoring-guidelines.md

For Library/Package Projects:

• Include: project-standards.md, git-workflow.md, documentation-standards.md
• Consider: versioning-strategy.md, publishing-guidelines.md

2. Core Document Templates

project-standards.md

# Project Standards and Guidelines

## Code Quality Standards
- Follow language-specific style guides (ESLint for JS/TS, Black for Python, etc.)
- Maintain consistent naming conventions across the codebase
- Write self-documenting code with clear variable and function names
- Include meaningful comments for complex business logic
- Keep functions small and focused on single responsibilities

## Testing Requirements
- Write unit tests for all business logic functions
- Maintain minimum 80% code coverage
- Include integration tests for API endpoints
- Write end-to-end tests for critical user flows
- Use descriptive test names that explain the scenario being tested

## Documentation Standards
- Update README.md for any significant changes
- Document API endpoints with clear examples
- Include setup and deployment instructions
- Maintain changelog for version releases
- Document architectural decisions in ADR format

## Security Practices
- Never commit secrets, API keys, or passwords
- Use environment variables for configuration
- Validate all user inputs
- Implement proper authentication and authorization
- Follow OWASP security guidelines

## Performance Guidelines
- Optimize database queries and avoid N+1 problems
- Implement caching where appropriate
- Use lazy loading for large datasets
- Monitor and profile performance regularly
- Consider scalability in architectural decisions

git-workflow.md

# Git Workflow and Branching Strategy

## Branch Naming Convention
- Feature branches: `feature/description-of-feature`
- Bug fixes: `fix/description-of-bug`
- Hotfixes: `hotfix/critical-issue-description`
- Releases: `release/version-number`

## Commit Message Format
Follow conventional commits format:

type(scope): description

[optional body]

[optional footer]

Types: feat, fix, docs, style, refactor, test, chore

## Pull Request Guidelines
- Create PR from feature branch to main/develop
- Include clear description of changes
- Link related issues using keywords (fixes #123)
- Ensure all tests pass before requesting review
- Squash commits when merging to keep history clean

## Code Review Process
- At least one approval required before merge
- Review for code quality, security, and performance
- Check that tests cover new functionality
- Verify documentation is updated if needed
- Ensure no breaking changes without proper versioning

frontend-standards.md

---
inclusion: fileMatch
fileMatchPattern: '*.tsx|*.jsx|*.vue|*.svelte'
---

# Frontend Development Standards

## Component Architecture
- Use functional components with hooks (React)
- Keep components small and focused
- Implement proper prop validation
- Use TypeScript for type safety
- Follow component composition patterns

## State Management
- Use local state for component-specific data
- Implement global state for shared application data
- Use proper state management libraries (Redux, Zu

...