Skip to content

Better structure in CouchDB definitive guide #343

Open
@ghost

Description

Thanks for the free book!

I want to make it even better as a reader by posting some suggestions:

It will be better if each page was built upon the knowledge from the previous page...it feels like you are talking about something a little here and a little there with no clear lines between them.

If I am on a page I want to know what this whole page is going to be about and not about some diffuse topic, but a very clear one eg. MAP, REDUCE etc. Then when I have a specific problem I know exactly where to look it up cause that page will contain EVERYTHING of that topic, not spread across over the whole book.

Also, I was totally lost when I read about reduce functions here (explanations of the map functions were pretty good): http://guide.couchdb.org/draft/views.html

I thought there was a lot missing for the reduce functions:

What do i want to do?
Why would I want to do it?
How do i do it?
Why do i do it like this?

You have to assume the coder knows nothing about map+reduce. Different examples (especially on reduce) so i understand "oh .. you write this reduce function and you get these results, now i see what its all about"

It just jumped to explain reduce functions right in the middle of it without basic explanation how it works at all imo. I read it two times without getting much more. Reduce function is one of the core features of CouchDB, so you have to really explain it more deeply, maybe having a whole page for it. It felt like listening to a salesman talking cause there were a lot of words used but with nearly no explanation and pictures. Pictures when talking about leaf nodes, sub nodes, inner nodes etc.

CouchDB is a really nice DB and I would like the documentation help users to understand how great it is!

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