DEV Community

Cover image for Finding knowledge is not hard. Putting it all together is.

Finding knowledge is not hard. Putting it all together is.

Tophe on May 11, 2018

The reason why I made topheman/npm-registry-browser In software development, a lot of great quality resources are available, often for f...
Read full post
Collapse
 
bhserna profile image
Benito Serna •

Nice work! ... I have been thinking in that also (tutorials vs projects)... I have been trying to teach what I think I know jaja... but is hard to find the best way to do it... and once you decide for one, is hard to actually do it!!...

I like how you are working to explain your decisions in the Readme... and just as a humble advice... one thing that could help the people that visit your project is to now the process that you use to tackle a new feature... like a little tutorial inside you project (I know this is what you want to avoid jaja), but just to know how they can add more code to software written in this way =)

Keep the good work!

Collapse
 
topheman profile image
Tophe •

Hie Benito,

Thx for the comment. As you understood, the goal of that project is to provide a project where you can find out how you would put all the bricks together (have a real example).

I intended from the start to make some blog posts and talk about some specific features. It will come along.

Meanwhile, I took some notes about some problems I stumbled upon and how I fixed them. It's available there : github.com/topheman/npm-registry-b... - maybe I should highlight it more in the README ...

Collapse
 
bhserna profile image
Benito Serna •

I didn't see that page!... I will check it out =) ... Thanks

Collapse
 
lobo_tuerto profile image
Víctor Adrián • • Edited

That's one of the reasons I like writing tutorials:

I have found there are mainly two types of tutorials one should write:

  • Scoped, focused tutorials.
  • Full step-by-step tutorials.

Scoped, focused tutorials, should be used to explain techniques, like this one: Fluid SVGs with Vue.js.

But, full step-by-step tutorials should be used to teach about new tech stacks.

Going from zero to fully working prototype without skipping steps.
With best practices baked-in, presenting the best libraries available for a given task.
I really like tutorials that take this holistic approach."

Excerpt from: Building a JSON API with Phoenix 1.3 and Elixir

This one is also written in the same spirit: Quickstart guide for a new Vue.js project