API Documentation Writing

Documents REST and RPC endpoints for blockchain node interaction. Uses OpenAPI for API description and includes JSON request/response examples for core operations.

Documents simple game systems: describes mechanic parameters, balance tables, interaction rules. Creates basic Game Design Documents (GDD) with core loop and main feature descriptions. Uses templates for structuring documentation.

Understands principles of writing developer-friendly API descriptions: clarity, completeness, usage examples. Knows the difference between reference docs and conceptual guides. Can write parameter and field descriptions in a clear style.

Creates detailed blockchain API documentation: describes data models, error codes, rate limits, and WebSocket subscriptions. Integrates auto-generated documentation from code via Swagger/Redoc.

Creates detailed technical documentation for game systems: event API descriptions, balance data structures, client-server interaction protocols. Writes specifications for external SDK integration (analytics, monetization). Documents configuration parameters for live-ops.

Writes comprehensive API guides: quickstart, authentication flow, error handling, use cases. Creates code samples in multiple languages (curl, Python, JavaScript, Go). Maintains terminology and style consistency across all API docs sections.

Designs documentation for platform blockchain API: changelog, versioning, migration guides. Ensures terminology and example consistency for external and internal consumers.

Designs technical documentation structure for the entire game project. Creates living documents that auto-update when configs change. Documents complex systems: economy, progression, meta-game. Writes technical specifications for cross-team interaction.

Creates advanced API documentation content: migration guides between versions, architecture overviews, best practices. Develops style guides for API descriptions. Conducts UX review of documentation from a developer experience perspective.

Defines API documentation standards for the blockchain organization. Introduces docs-as-code approach and review process for technical documentation. Coordinates technical writers.

Defines documentation standards for game systems across the entire studio. Establishes templates for GDD, technical specifications, balance sheets. Implements documentation review processes and knowledge sharing between teams. Ensures documentation stays current throughout the project lifecycle.

Builds a content strategy system for API documentation at the product level: content types, audience mapping, content lifecycle. Coordinates work between writers and developers. Implements user feedback loops for continuous documentation improvement.

Shapes developer experience strategy at organizational level. Defines approaches to public documentation, SDK guides, and developer onboarding for the blockchain platform.

Shapes documentation culture at the organizational level. Defines enterprise documentation standards for the game project portfolio. Evaluates and implements documentation automation tools: Confluence, Notion, custom wiki. Creates methodology for knowledge transfer between studio projects.

Defines technical writing standards for API documentation at the company scale. Shapes approaches to multi-audience documentation (internal devs, partners, public). Researches and implements best practices from leading developer portals (Stripe, Twilio, GitHub).