Kotlin Analysis API Development Guidelines¶

This series of guides provides comprehensive instructions for developing and maintaining the Kotlin Analysis API. They are intended for:

• JetBrains developers working on the Analysis API core, implementations, and platform integrations
• External contributors submitting patches and improvements to the Analysis API
• Tool developers who want to understand the design philosophy and best practices behind the API

The guidelines cover API design principles, implementation patterns, naming conventions, and evolution strategies that help maintain consistency and quality across the codebase.

Guidelines¶

API Development Guide¶

This document covers principles and practices for developing new Analysis API endpoints, including design patterns, naming conventions, documentation standards, and requirements for API implementations.

API Evolution Guide¶

This document covers the lifetime of individual Analysis API endpoints from introduction to deprecation.

Endpoint Card¶

A template for systematic analysis of existing API endpoints to support refactoring, enhancement, or deprecation decisions.