routine-parameter-design

What problem does it solve?

Designing stable and maintainable APIs requires careful parameter lists. This skill helps you minimize parameter count, order parameters effectively, choose appropriate pass semantics, and document each parameter for clarity so that functions and interfaces remain easy to use and evolve.

Core Features & Use Cases

• Minimize parameter count to improve readability and usability of functions and APIs.
• Order parameters using the input-modify-output pattern to clarify data flow.
• Choose appropriate pass mechanisms (by value vs by reference) and prefer parameter objects when helpful.
• Ensure interface consistency across related functions, modules, and APIs.
• Document and name parameters clearly, including constraints, ranges, and units when applicable.
• Validate parameter usage and avoid global variables to reduce side effects and improve testability.

Quick Start

Refactor a function signature to minimize parameter count, order parameters as input-modify-output, and document each parameter clearly.