Skip to content

Instantly share code, notes, and snippets.

@woloski

woloski/option1-prose.md

Last active August 29, 2015 14:08
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save woloski/37f4c337462bb770f8d3 to your computer and use it in GitHub Desktop.
Save woloski/37f4c337462bb770f8d3 to your computer and use it in GitHub Desktop.
Download ZIP
Which style would you prefer for a blog post?
Raw
option1-prose.md

Why developers fall in love with your product?

1. Awesome docs

What do we do the first time we want to use a library? We read the Github README or the Wiki. Why? First and foremost, because we can do what we know best: Copy & Paste code snippets. Also, it gives us an overview of how we can use the library and the APIs it has. If the APIs weren’t good, we’d just search for another one.

Products should follow this same idea. We should have documentation from which we can copy and paste. For a product, that means tailored documentation for every user.

Another thing we love is reading code. It’s literature for us!That’s why it’s nice if every document includes an up-to-date sample for every major platform/technology that we can just download, run locally and read its code.

2. to be continued ...

Raw
option2-bulllets.md

Why developers fall in love with your product?

1. Awesome docs

This topic deserves its own post. But here are the top 5 things that make me fall in love with a product:

  • Copy pastebale code snippets,
  • A great API documentation ideally with interactive execution or copy-pasteable curls,
  • up-to-date examples for every major platform/techonlogy,
  • github repos with clear READMEs
  • ++ if the code snippets are already tailored with my API keys

2. to be continued ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment