We have partnered with TradePub to bring you free industry magazines and resources - no coupons or credit cards required!

Visit: englishforums.tradepub.com


1 2
Share this topic:
This question is Not Answered
Latest post Thu, Apr 16 2009 12:48 PM by Ruslana. 10 replies.
Suggest an answer | | |
RayH  +  697873 Wed, 15 Apr 09 06:16 PM
It would make things considerably eaisier if us ordinary schlub users had some documentation that explained things like how the editors work (spell check, shortcut keys, etc), what the various symbols and icons mean, what the different colors mean when applied to icons that are otherwise the same, what the different display formats and colors mean in the message forums, etc., etc. etc.


Is there any such thing? How do we access it?

Joined on Sat, Mar 22 2008
Contributing Member 1,555
Native speaker of U. S. English. Not a grammar expert.
Punkybrewster  +  697877 Wed, 15 Apr 09 06:25 PM
Hi Ray,

When you mouse over the editor buttons, you will see a tooltip that explains what each button does.


Good idea about the icons (I'm assuming you mean the icons that turn grey in thread view, once a thread has been read?). This I could add to our FAQ's.
Though I'm not too sure what you mean about "display formats"?



Joined on Sun, Nov 6 2005
Malta
Contributing Member 1,168
There is only one satisfying way to boot a computer. ~J.H. Goldfuss
RayH  +  697895 Wed, 15 Apr 09 06:53 PM
Punkybrewster
“Though I'm not too sure what you mean about "display formats"?”

In this thread Goodman's post is yellow and it is followed by a kind of grayed out version that displays as though it is mean to look like a torn sheet of paper.


In this thread (top of the second page) Marius' post is shown in a different format (his avatar is on the left and the post is in a kind of minimized format) compared with the usual format of most of the other posts including Clive's post immediately below and Marius' other post earlier in the same thread. I'm sure there are others but these are the most obvious.


Punkybrewster
“When you mouse over the editor buttons, you will see a tooltip that explains what each button does. ”

Rollover tool tips are all well and good but they do not constitute proper documentation.


Punkybrewster
“This I could add to our FAQ's.”

FAQs are useful but again they do not constitute proper documetation.


Am I to assume that the organization that created this software did not create any user

documentation? Or do they refuse to make it available? If so why?


By the way the more I use the "standard" editor the less I like it.

Ruslana  +  697904 Wed, 15 Apr 09 07:21 PM
Hey Ray,


Documentation is good, I agree. But I've NEVER come across a website (forum) supplied with any other "user manuals" except FAQs, and I do think creation of those would be excessive. Oh come on, would you really like them to explain what "reply" and "quote" buttons mean and how to use them properly?? Wink

Joined on Sat, Dec 17 2005
Senior Member 3,680
RayH  +  697906 Wed, 15 Apr 09 07:25 PM
Ruslana
“what "reply" and "quote" buttons mean and how to use them properly??”

Very clever. Not very funny.

hitchhiker  +  697909 Wed, 15 Apr 09 07:40 PM
Hi RayH, Your post was written in quite a stern and logical tone, no problem at all - I quite like it. I'd like to also reply in a similar 'logical' manner if possible.


Given that we're in the context of 'The internet' and not 'The Tate Gallery' ;)


- FAQs do constitute proper documentation - though we're currently working to include as many new questions and answers as feasible.


- Most information on the screen is organised to be reasonably self-explanatory to a person mildly familiar with this environment. Those parts that are not, are 'tool-tipped'. If we were to include all information (on screen) that was necessary to logically (assuming no intuitive motion) describe each element - the page layout would be overwhelmed.


- This is the case with most websites, as they expect their users to accept a degree of inherent 'confusion'. We couldn't possibly expect our new users to leaf through the 2,500 pages of documentation needed to fully understand the various functions of this system.


There are many questions and many answers, if any indicators are missing from the screen that inhibit a intuitive understanding of the page logic - we will add them.


eg: The Goodman page:

http://www.englishforums.com/English/AgainDifficultyUsing/wzxqk/post.htm


-This page is a question and answer thread - as indicated at the top of the page.


-As you scroll down you can see that the first post must be the Question (assumed)


-Scrolling below that you can see the 'strongly' coloured 'Answers' - also marked with 'Best answer'


-Below that you can see a dividing line that refers to "All the other replies.." - we could rename that 'original thread' though some might not understand 'thread''


-Below that the post (one of the answers) indicates that it has been 'cut off' - with the text 'Click to see this verified answer' - this is because removing the answers from the original thread (as we did in the previous version) caused discontinuity in the resulting thread progression. Hence now you have the option to easily view it, but it's semi-hidden to illustrate that it's been moved to the answers location.


The resulting thread compacts the questions and 'relevant' answers into a format that a visiting user (never seen our site before - coming in with a 20 second attention limit) can easily digest. ie: They don't care what the various things on the rest of the page mean, they only want to see the answer to the question they are seeking. Beyond that, more experienced users can extrapolate detailed information if needed.


Hope this helps,

Frank.

Joined on Mon, Nov 18 2002
Richmond, UK
Senior Member 4,036
Usenet is like a herd of performing elephants with diarrhea - massive, difficult to redirect, awe-inspiring, entertaining, and a source of mind-boggling amounts of excrement...
Ruslana  +  697912 Wed, 15 Apr 09 07:42 PM
RayH
Ruslana
“what "reply" and "quote" buttons mean and how to use them properly??”

Very clever. Not very funny.


Sorry but your posts indeed made me smile. Smile You know why? Because I used to work in a Technical Publications department for a company designing and producing aircraft, and we had LOTS of documentation to create: Aircraft Maintenance Manual, Structural Repair Manual, Fault Isolation Manual, Aircraft Illustrated Parts Calatog, Wiring Manual, and many more. They were all aimed to explain how to use the whole AIRCRAFT. In comparision to that, a manual for a FORUM sounds... eh, it just really made me smile. Sorry again if anything. I meant no offence! Smile

RayH  +  698089 Thu, 16 Apr 09 06:53 AM
Ruslana
“I meant no offence!”

No offense taken. It's just that I find it passing strange that a simple request for user documentation (not administrator documentation, not developer documentation) seems to have taken the administrators of the site completely by surprise. There are three, yes three, editors available, for example. It seems reasonable that there would be some description of the major features of each and the differences between them. Apparently not, at least not that a common user is allowed to see.


Another example. There are many graphic features used on the site with very few of them explained (probably at least two dozen icons some of which take on different colors for no apparent reason, the background color of the posts changes with no explanation, the poster's avatar suddenly appears on the left side of his post instead of the right, etc.). Doing all of that takes a non-trivial amount of developer effort but what's the point if the user doesn't know what it all means and can't find out? I suppose it's possible that the developers do that for their own benefit and information, if so they should just say so and be done with it. I guess it's also possible that all of this is old hat and is thoroughly documented elsewhere on the Internet, if so why not just post a link to the information and call it a day.


I guess I've learned my lesson. It's pretty obvious that there is not going to be any documentation made available beyond a FAQ or two. It's not beyond the realm of possibility that the only real documentation is the actual source code of the site. I've seen situations like that myself. But again I have to say that if that's the case the administrators should just say so and be done with it.


In any case this is my last post on the matter. If the administrators see fit to make documentation available at some point (or not) so be it.

hitchhiker  +  698129 Thu, 16 Apr 09 11:45 AM
...that the only real documentation is the actual source code of the site.”

Yep, absolutely true.


Thanks for your reply RayH, though I did try to be as clear as possible in my previous post:


We can't document every feature, but those (such as some you've just mentioned above) - deserve documentation in the form of an FAQ (The web-standard for documentation).


Speaking Frankly: Your posting above seems excessive and IMHO only a small amount of people would ever view documentation to that extent. Regardless, your contribution here has helped, and is being taken into consideration as we speak. Actually, better than that, we're writing up those missing details right now..


Thanks,
Frank.

1 2
© MediaCet Ltd. 2009, v5.0.3614.32638. All content posted by our users is a contribution to the public domain, this does not include imported usenet posts.*
For web related enquires please contact us on webmaster@mediacet.com, status updates are available at status.mediacet.com.
*Usenet post removal: Use 'X-No-Archive'. You may not have understood that your posts would end up in the public domain. Please send proof of the poster's email, we will remove immediately.