What does a good guide have? #3

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.

Sign up for GitHub

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

Jump to bottom

Open

pocc opened this issue May 1, 2019 · 1 comment

Contributor

pocc commented May 1, 2019 •

edited

Loading

Some guides are AWESOME! And some ... aren't.

Qualities

I've come up with some things that I think make python-guide.org and postgresguide.org stand out:

Comprehensive on $subject without being cumbersome
Scoped clearly
Searchable
Skimmable
Easy to contribute to
Updated regularly
TOC that is either a sidebar or easily accessible

Thoughts?

Member

kennethreitz commented May 1, 2019

Yes, I think a separate section for ones that aren't updated regularly may be in order.

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