DEV Community

Blog Posts vs Docs - Where to Place Content?

Ricardo N Feliciano on October 29, 2018

Whether it's with a co-worker or someone I meet at a meetup, I tend to discuss one of three topics: Open Source, Community, or Documentation. Whe...
Collapse
 
helenanders26 profile image
Helen Anderson

This is great! Thank you for writing up the distinction between blogging and docs, I had the same discussion with a colleague recently on the issue of timeliness.

Collapse
 
felicianotech profile image
Ricardo N Feliciano

Thank you. I'm glad I wasn't the only one discussing this. :)

Collapse
 
qew7 profile image
Maxim Veysgeym

i think that everything you need to work (even in form of links) should be in readme on github page

Collapse
 
felicianotech profile image
Ricardo N Feliciano

everything you need to work

What do you mean by this?

A README.md file on GitHub, which is a crucial file, is documentation. So I believe whatever applies to docs applies to that file. Meaning theory, news, etc shouldn't be there. Instructions, intro, description, should.