terminal-001 should GuidesAPI docs Show expected output for code samples, either in a separate section or via code comments; use a standard introductory phrase to separate command from output.
Terminal
Commands are only half of a terminal interaction: readers also need to know what a successful run looks like. This page covers how to present command output alongside the commands that produce it.
Show expected output
Section titled “Show expected output”Examples
- ✓
tool services list, then “The output is similar to the following:” introducing a separate output block - ✗ Command and output in a single block with nothing marking where one ends and the other begins
Rationale
Showing expected output lets a reader confirm their run matches and understand what the command produces.