keeton, not sure if you are being sarcastic or not here, hopefully not ;-) If you are, do you have any sound advice as to how we can improve them?
keeton
Joined: 2004-01-30
Posts: 25
Posted: Sat, 2004-09-18 17:40
Well, h0bbel, I was kinda backing you up on this issue. A single word reply (RTFM) didn't seem appropriate, but it did sprung to mind.
Most I know about gallery is from the manuals, the FAQ and the forums. Although I do think that the FAQ can use a little more structure (Postnuke has this beautifull FAQ module) and layout, community support is very good here.
The point here, as with every community forum is that a lot of new users have no idea of how to use the search function. I think almost every question has been asked and answered before and unless some new version of way of installation is developed, every issue can be found here.
That is just it.
Grtz
h0bbel
Joined: 2002-07-28
Posts: 13451
Posted: Sat, 2004-09-18 22:52
keeton, we have been given a lot of, rightfully so, criticism on the documentation, so I'm jumping at every chance to get some feedback on them. Thanks.
keeton
Joined: 2004-01-30
Posts: 25
Posted: Sun, 2004-09-19 21:49
As I said, I genuinely like the docs. I just get the feeling they were written by an engineer and you need an engineers mind to read them. That can be considered an observation, not critisism, I cannot do any better.
Also, it has the worst layout I even encountered in a FAQ. Well, one that supports a project this big. It just strains my eyes looking at it, that is my main point of critisism. Layout, Layout and more layout are the key points in improving the docs.
On the other hand, most questions one reads in any forum about a populair piece of open source software are already answered. The same goes for documentation. If one doesn't read any of these, what is the point in posting a question.
Also I always keep in mind that the windows approach is not used in most OpenSource projects. The windows apporach: Click yes to install this progamme and let the installer screw up any special settings you made. (or worse, insert disk and you have autorun enabled? Good, now we can make sure you never get rid of us.) The OS approach has some assumptions that are not commonly known to most mortals. This is no real problem, as most mortals need the windows approach.
You guys do a great job at Gallery. My sarcasm just carries me away sometimes.
Keep it up,
Grtz,
Keeton
h0bbel
Joined: 2002-07-28
Posts: 13451
Posted: Sun, 2004-09-19 21:55
keeton, I really wasn't sure what your intention was with your initial post. As for the FAQ layout, well considering we do it in docbool / xml to provide several possible output formats, I'm not sure if we can improve it that much. It was way worse before we switched to docbook in the first place
As for the rest of the docs, the next revision will include screenshots and probably a great deal of re-writing.
keeton
Joined: 2004-01-30
Posts: 25
Posted: Sun, 2004-09-19 22:04
I noticed you were having trouble deciding between anger (flame) or amusement (sarcasm towards user posting question asked a zillion times before).
I am not familair with all these different formats, I just know that looking at noted document makes my eyes hurt.
Won't the new docs be available with version 2?
Grtz,
Keeton
btw: almost everybody who has trouble finding a document that solves their problem claims it is the docs fault. Whether or not that person can search like lassie or like a blind man in a silo of custard. It doesn't matter, it is always the docs fault.
h0bbel
Joined: 2002-07-28
Posts: 13451
Posted: Sun, 2004-09-19 22:11
keeton, well, considering that I'm now over 6000 posts, some times you get a bit... ambivalent
As for G2 docs, I'm not sure how they will shape up. G1 docs are due for a revision for the 1.4.5 release. And I agree, if people can't find the information available to them, it's our fault. We do our best though
alindeman
Joined: 2002-10-06
Posts: 8194
Posted: Sun, 2004-09-19 22:19
The docs can be outputted (speling?) in any way we want... However, speaking for myself, I cannot design worth a flip .. If anyone wants to jump in and create us some better transforms and/or CSS, we'd be happy to try and implement that.
keeton
Joined: 2004-01-30
Posts: 25
Posted: Sun, 2004-09-19 22:21
I know the feeling.
Again, I know the feeling.
Also, I suggest we close our private conversation in this topic. Poor Eminem must think he is being dissed and I would hate him writing a rap song about it.
Posts: 13451
keeton, not sure if you are being sarcastic or not here, hopefully not ;-) If you are, do you have any sound advice as to how we can improve them?
Posts: 25
Well, h0bbel, I was kinda backing you up on this issue. A single word reply (RTFM) didn't seem appropriate, but it did sprung to mind.
Most I know about gallery is from the manuals, the FAQ and the forums. Although I do think that the FAQ can use a little more structure (Postnuke has this beautifull FAQ module) and layout, community support is very good here.
The point here, as with every community forum is that a lot of new users have no idea of how to use the search function. I think almost every question has been asked and answered before and unless some new version of way of installation is developed, every issue can be found here.
That is just it.
Grtz
Posts: 13451
keeton, we have been given a lot of, rightfully so, criticism on the documentation, so I'm jumping at every chance to get some feedback on them. Thanks.
Posts: 25
As I said, I genuinely like the docs. I just get the feeling they were written by an engineer and you need an engineers mind to read them. That can be considered an observation, not critisism, I cannot do any better.
I think this section is most used:
http://gallery.menalto.com/modules.php?op=modload&name=GalleryDocs&file=index&page=gallery1-install.faq.c.php
Also, it has the worst layout I even encountered in a FAQ. Well, one that supports a project this big. It just strains my eyes looking at it, that is my main point of critisism. Layout, Layout and more layout are the key points in improving the docs.
On the other hand, most questions one reads in any forum about a populair piece of open source software are already answered. The same goes for documentation. If one doesn't read any of these, what is the point in posting a question.
Also I always keep in mind that the windows approach is not used in most OpenSource projects. The windows apporach: Click yes to install this progamme and let the installer screw up any special settings you made. (or worse, insert disk and you have autorun enabled? Good, now we can make sure you never get rid of us.) The OS approach has some assumptions that are not commonly known to most mortals. This is no real problem, as most mortals need the windows approach.
You guys do a great job at Gallery. My sarcasm just carries me away sometimes.
Keep it up,
Grtz,
Keeton
Posts: 13451
keeton, I really wasn't sure what your intention was with your initial post. As for the FAQ layout, well considering we do it in docbool / xml to provide several possible output formats, I'm not sure if we can improve it that much. It was way worse before we switched to docbook in the first place
As for the rest of the docs, the next revision will include screenshots and probably a great deal of re-writing.
Posts: 25
I noticed you were having trouble deciding between anger (flame) or amusement (sarcasm towards user posting question asked a zillion times before).
I am not familair with all these different formats, I just know that looking at noted document makes my eyes hurt.
Won't the new docs be available with version 2?
Grtz,
Keeton
btw: almost everybody who has trouble finding a document that solves their problem claims it is the docs fault. Whether or not that person can search like lassie or like a blind man in a silo of custard. It doesn't matter, it is always the docs fault.
Posts: 13451
keeton, well, considering that I'm now over 6000 posts, some times you get a bit... ambivalent
As for G2 docs, I'm not sure how they will shape up. G1 docs are due for a revision for the 1.4.5 release. And I agree, if people can't find the information available to them, it's our fault. We do our best though
Posts: 8194
The docs can be outputted (speling?) in any way we want... However, speaking for myself, I cannot design worth a flip .. If anyone wants to jump in and create us some better transforms and/or CSS, we'd be happy to try and implement that.
Posts: 25
I know the feeling.
Again, I know the feeling.
Also, I suggest we close our private conversation in this topic. Poor Eminem must think he is being dissed and I would hate him writing a rap song about it.
Grtz,
Keeton
Posts: 8194
Whatever 8-)
Posts: 25
the reply was to H0bbel...
Posts: 8194
Whatever 8-)
Posts: 25
O. I get the point.
Posts: 13451
keeton, the topic has been split and moved to a more appropriate area. Hopefully we can get some more people commenting on this, as we need all the feedback we can get. http://gallery.menalto.com/index.php?name=PNphpBB2&file=viewtopic&p=95813#95813 is also a good place to post suggestions.
Posts: 25
Okee, I will leaf through the current docs and see if there is anything else that catches my eye and is worth some reconsideration.
You will hear from me again.
Grtz
Posts: 13451
keeton, great! Looking forward to it.