Skip to main content

Human

Design your commands for humans. Have a conversation. Speak the Siemens brand: Authentic, open and engaging.

Interactivity​

  • Offer interactive modes when developing primarily for human interaction
  • Tell users which environment they are in (interactive / non-interactive)
  • Use --no-input when you don't want to interact with your terminal
  • Ensure users can exit anytime

Interactivity 1 - Do

Interactivity 1 - Don't

Interactivity 2 - Do

Interactivity 3 - Do

Interactivity 3 - Don't

Output​

  • Return brief response messages, e.g. x done / x created / x named / x not done / x not created / x not named
  • Respond by repeating command words, e.g. createdevice = device created / device not created
  • Give command suggestions
  • Use everyday, understandable language
  • Use color when necessary and with reason
  • Use well-known symbols to boost clarity when supported
  • Tell users when there are state changes
  • Avoid buzz words and jargon
  • Avoid emojis to express emotions to align with our brand voice and style

Output 1 - Do

Output 1 - Don't

Output 2 - Do

Output 2 - Don't