← Docs home

Document Output Objects

📐 Rule.

PowerShell consumes the objects a cmdlet writes to the pipeline. Document the objects your cmdlet returns, and document what the members of those objects are used for.

Why.

Downstream cmdlets and scripts bind to the returned objects by their members. Users cannot take advantage of the output unless the object shape and its members are documented.