Write Documentation Code Examples for Production Readiness

This skill guides writing, rewriting, and formatting code snippets in documentation so they can be directly reused or integrated into production Java applications while maintaining stylistic consistency across the document.

Core Principles

1. Preserve Document Context and Style Consistency

Always align with patterns and conventions established earlier in the same document:

• Consistent Builder / Factory Pattern: If early sections establish building a client via a method returning Client.Builder (e.g., public Client.Builder createBaseClient()), subsequent configuration options (auth schemes, TLS, proxy, timeouts) must follow the same pattern rather than reverting to creating full Client instances from scratch.
• Incremental Context: Sub-sections and options should build consistently on preceding examples (e.g., public Client createAnalyticsDBClient(Client.Builder baseClient)).
• Naming Conventions: Maintain consistent method, variable, and parameter names (createBaseClient, client, schema, settings, events) across all snippets in the document.

2. Wrap Code with Methods

Never present bare, loose statements floating outside a method. Encapsulate every snippet into a realistic, reusable method:

• Use factory methods or builder helpers for client instantiation (e.g., public Client.Builder createBaseClient(), public Client createAnalyticsDBClient(Client.Builder baseClient)).
• Use action-specific methods for queries, inserts, and updates (e.g., public List<Event> readEvents(Client client, TableSchema schema), public void writeEvents(Client client, List<Event> events)).
• Use clear parameter lists (Client client, TableSchema schema, InsertSettings settings, etc.) and meaningful return types instead of writing top-level procedural scripts.