WindsurfDocumentation
Documentation Ai Rules for Windsurf
Generic AI coding rules for Windsurf. Improve consistency, output quality, and SEO discoverability with copy-paste ready conventions.
.windsurfrules
# Documentation Ai Rules for Windsurf Use this ruleset in `.windsurfrules`. ## Universal AI coding principles - Be explicit with goals, constraints, and acceptance criteria. - Enforce clean architecture, readable naming, and test coverage. - Validate inputs, handle errors intentionally, and avoid silent failures. - Keep changes small, reviewable, and reversible. - Write docs for non-obvious decisions and trade-offs. ## Prompting and implementation rules - Ask for clarifications when requirements are ambiguous. - Prefer deterministic logic and stable interfaces. - Avoid introducing unneeded dependencies. - Match existing style/lint/test pipeline exactly. - Include migration notes for any breaking behavior. ## Shipping checklist - Lint passes - Type checks pass - Tests pass - Performance and security risks reviewed - README/changelog updated when behavior changes
How to use with Windsurf
Create a `.windsurfrules` file in your project root. Windsurf's Cascade AI applies these rules automatically.
#windsurf#general#ai-coding-rules#generic-ai-rules#documentation-ai-rules
Related Rules
TypeScript Windsurf Rules
WindsurfTypeScript
Windsurf rules for TypeScript: strict type safety, functional patterns, and modern TypeScript conventions.
Code Style
typescript · windsurfCopy Ready
React Windsurf Rules
WindsurfReact
Windsurf rules for React: modern patterns, performance, and scalable React architecture.
Architecture
react · windsurfCopy Ready
Go Windsurf Rules
WindsurfGo
Windsurf rules for Go: hexagonal architecture, clean code, observability, and production Go patterns.
Architecture
go · windsurfCopy Ready
Rust Windsurf Rules
WindsurfRust
Windsurf rules for Rust: async Rust, WASM, systems programming, and production Rust patterns.
Architecture
rust · windsurfCopy Ready