kotlin-api-guidelines

Design Kotlin library APIs with binary compatibility and multiplatform guidelines.

Updated Jul 20, 2026
One-click install
npx skills add https://github.com/trancee/MeshLink-template --skill kotlin-api-guidelines
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kotlin-api-guidelines
Source: https://github.com/trancee/MeshLink-template/tree/main/.agents/skills/kotlin-api-guidelines
Command: npx skills add https://github.com/trancee/MeshLink-template --skill kotlin-api-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the complexity of designing professional-grade Kotlin libraries by providing standardized rules for API design, backward compatibility, and multiplatform support.

Core Features & Use Cases

  • API Design Standards: Enforces simplicity, readability, and consistency through explicit API mode and DSL builders.
  • Compatibility Management: Provides strategies for maintaining binary and source compatibility using the Binary Compatibility Validator and deprecation cycles.
  • Multiplatform Readiness: Offers guidance on designing common code, handling platform-specific behavior, and ensuring Swift interop.
  • Use Case: When refactoring a library to support Kotlin Multiplatform, use this skill to verify that your public API remains binary-compatible and that your documentation follows the Diátaxis framework.

Quick Start

Use the kotlin-api-guidelines skill to review my proposed public API changes for binary compatibility and suggest improvements based on official Kotlin library author guidelines.

Frequently Asked Questions about kotlin-api-guidelines

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

FAQPage Schema
How do I design a Kotlin library for binary compatibility?

To design a Kotlin library for binary compatibility, enforce explicit API mode and use the Binary Compatibility Validator to track public API changes. Maintain backward compatibility by following structured deprecation cycles for evolving public-facing code.

What is the best way to ensure source compatibility when refactoring a Kotlin library?

Ensuring source compatibility when refactoring a Kotlin library requires applying proper deprecation cycles and reviewing public API changes. Use the Binary Compatibility Validator to prevent accidental API breakage during library evolution.

How do I handle Kotlin Multiplatform architecture when designing common code?

Handling Kotlin Multiplatform architecture involves designing common code carefully to support platform-specific behavior. You should ensure Swift interop readiness and verify that your public API remains stable across targeted multiplatform environments.

When do I need explicit API mode in Kotlin library development?

You need explicit API mode in Kotlin library development to enforce simplicity, readability, and consistency. It prevents accidental public exposure of internal implementation details, ensuring your library API remains predictable and maintainable.

Can I use DSL builders for Kotlin API design without breaking compatibility?

Yes, you can use DSL builders for Kotlin API design without breaking compatibility by applying standardized design principles. Combine them with the Binary Compatibility Validator to ensure your DSL interfaces remain stable across library versions.

How do I document a Kotlin library using the Diátaxis framework?

Documenting a Kotlin library using the Diátaxis framework requires structuring documentation into tutorials, how-to guides, reference, and explanation. This ensures your public-facing code documentation meets official standards for simplicity and testability.