Hi, I just heard of Chyrp via Daring Fireball, and it looks interesting. However, I noticed a problem right off the bat: the docs are way too low level. For example, I tried out the demo, and browsed the extensions. But nowhere on the site have I found a definition of what a [i]module[/i] is, or what a [i]feather[/i]. I'm a software architect, so I have a pretty good idea anyway, but I suggest that adoption will be stronger if the home page of "docs" starts out high level, with an explanation of what Chyrp is, how it's architected, and what the various relevant terms are.

Thanks!
Avi

Yeah, I understand. I'm suggesting that you revamp the docs a little, maybe add in some non-developer documentation.

Alex, we don't need to get into a debate about it. Hopefully you'll consider my feedback and keep it in the back of your head; I don't know exactly what your goals are for Chyrp, but if they include widespread adoption, then I think you'll eventually need to add some more explanatory content to the site. The wiki might be a good place for that sort of content, if you integrate it into the site a little more, and at least add some scaffolding for that introductory explanatory content.

Another example of the lack of definition/explanation: the wiki page [url=http://wiki.chyrp.net/docs/show/Creating+Feathers]Creating Feathers[/url] says that among others, some of the responsibilities of Feathers are creating and updating [i]Tweets[/i]. But I can't find a definition of a [i]Tweet[/i] anywhere in the site, the wiki, or the download. I'm guessing that a Tweet is akin to a Post, but I'm not sure. Could be a reference to [url=http://twitter.com/]twitter[/url]!

Here's an alternate suggestion: add some in-line help to the admin interface. When I went in to the demo/admin/extend, there were three tabs on the page, and I didn't know what two of them were. Some kind of in-line help right there, explaining what a module is, what a feather is, a tweet, etc, would be very useful, IMHO.

Thanks,
Avi

Look, I'm not debating it. I'm just saying that doing this would just result in an area that too much time was put into that no one will use. Time that could have been better spent doing something else. I'm updating the Wiki page at the moment to replace the old terminology, but beyond that most documentation is in the getting_started.html file. If someone else wants to do it I'm not going to stop them, but I'm not going to dedicate time to make a page that explains that the sky is blue.