Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logging + Error handling #74

Open
dialex opened this issue Jan 5, 2019 · 1 comment
Open

Logging + Error handling #74

dialex opened this issue Jan 5, 2019 · 1 comment

Comments

@dialex
Copy link
Owner

dialex commented Jan 5, 2019

Related with #17

@dialex dialex added the 6.fields label Jan 5, 2019
@dialex dialex added this to the v0.6-Fields milestone Jan 5, 2019
@dialex dialex added this to Untriaged in Writing via automation Jan 5, 2019
@dialex
Copy link
Owner Author

dialex commented Jan 5, 2019

Every error is an obstacle that gets in the way of what users are trying to do. A reliable system detects unexpected or unwanted events, tries to gracefully recover from them, and finally warns the user about it.

Think carefully about the message, ie. what caused it and who will read it. A good error message helps the user solve the problem and move on. An unhelpful message can mean the difference between continuing or giving up.

  • Find the right tone
    • 👎 Avoid being too technical or detailed
    • 👍 Be positive without sounding goofy
  • Explain what happened and why
    • 👎 You're ineligible for this offer
    • 👍 You've taken a trial before, so you're not eligible for this offer
  • Suggest a next step
    • 👎 App is out of date
    • 👍 To keep using the app, download the latest version here

Notice that the "user" can be a developer or someone from the customer support.

-- The Art of the Error Message

@dialex dialex added the create label Jan 6, 2019
@dialex dialex changed the title Error handling Jan 6, 2019
dialex added a commit that referenced this issue Jan 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
1 participant