Skip to content

What does a good guide have? #3

@pocc

Description

@pocc

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions