Using WIKI for Help
-
Hi Guys, I approve of the Wiki help! By sure this is the best idea to reduce file size, ensure international translation and upload loads of Video tutorials!
However, there must be some form of downloadable wiki via PDF for users offline, admin, for training etc etc.
I am more than happy to help with Video’s, administrative amendments to help tutorials etc just ask :)
Time’s are changing! the old days of manuals being on paper or as a chm file are soon going.
-
Generally, I prefer local help documents over being passed to a website, but I can deal with web-based help. Just make sure search works well (for some reason web-based search often nets too many useless results) and that the navigation isn’t poor like it is on very many websites - including MSDN (at least in Firefox, maybe it’s better in IE).
I’d also be perfectly fine with the fundamental help file being local with pointers/links to online content for videos or a continuously updated wiki for more detailed or user-driven help content. Actually, this seems pretty ideal from my point of view as an end-user.
However, one thing I’m curious about: how is having the Help documents be a web-based Wiki any particular benefit for translations? Doesn’t the same amount of material - maybe even more - still need to be translated?
What am I missing?
-
Generally, I prefer local help documents over being passed to a website, but I can deal with web-based help. Just make sure search works well (for some reason web-based search often nets too many useless results) and that the navigation isn’t poor like it is on very many websites - including MSDN (at least in Firefox, maybe it’s better in IE).
I’d also be perfectly fine with the fundamental help file being local with pointers/links to online content for videos or a continuously updated wiki for more detailed or user-driven help content. Actually, this seems pretty ideal from my point of view as an end-user.
However, one thing I’m curious about: how is having the Help documents be a web-based Wiki any particular benefit for translations? Doesn’t the same amount of material - maybe even more - still need to be translated?
What am I missing?
difference is huge - with online help, you have collaboration platform, so you can have 2-3-4 people help with for instance Romanian translation.
With chm, its a a html file you have to edit in some editor, then you have to edit index file and then build it. It is not only technically more complicated, it is also a lot harder to get several people to work on it at the same time.
Main reason we dont have at least 10 extra translations is that translator gets 100 pages to translate and it is really an huge task.
As to the navigation, it wouldnt change from current help - it would be context sensitive just like current one.
Of course, we would be the ones writing English and German translations, so quality of Help would only improve (ie random people would not be writing help).
-
also, if we had extra 10 translations, then international version would be 30 MB large… which makes little sense in 2011, where everyone is online… Plus we could build PDF help file, which is also printable for offline use.
Dont take me wrong - making it a online help, is a huge task, and for me personally, it would be A LOT of work. A LOT.
-
Dont take me wrong - making it a online help, is a huge task, and for me personally, it would be A LOT of work. A LOT.
Well if you have enough time for holidays then you arnt busy enough! ;)
-
@Sir:
Well if you have enough time for holidays then you arnt busy enough! ;)
just pointing out that this is an harder road to take, but in few months, it would be rewarding…
-
well what happens if someones internet connection is down and they need help .
What libre office does is to have an online and offline help but the offline help can be downloaded and installed separetely
-
well what happens if someones internet connection is down and they need help .
What libre office does is to have an online and offline help but the offline help can be downloaded and installed separetely
as mentioned above, they would have PDF help that would also be printable.
-
here is (just) an example of help file for ZTE:
http://wiki.attachmentcloud.com/zip_to_emailkeep in mind that this is an alpha version and that text is just copied over from PAOP, it is not actual ZTE help.
but it shows how easy would be for someone to translate it…literally minutes. and it kind of looks cool too :-)
-
here is (just) an example of help file for ZTE:
http://wiki.attachmentcloud.com/zip_to_emailkeep in mind that this is an alpha version and that text is just copied over from PAOP, it is not actual ZTE help.
but it shows how easy would be for someone to translate it…literally minutes. and it kind of looks cool too :-)
Had a look and im happy! it is clear, fast and exactly what i would expect.
when can we have the application to download then? ;)
-
and it kind of looks cool too :-)
It looks a damned site better than some Wikis I have had the misfortune of trying to use in the past that’s for sure.
I still want to see a larger font though.
-
It looks a damned site better than some Wikis I have had the misfortune of trying to use in the past that’s for sure.
I still want to see a larger font though.
font is actually +1 compared to our current help :-).
-
-
we can make ± that you can click to get bigger font sizes.
-
we can make ± that you can click to get bigger font sizes.
That would be an ideal solution. :)
-
i am glad you guys like it…
-
‘Table of Contents’ issue with font size ???
or are you still tweaking…?
-
you should have looked before :-)… right now it is still in testing mode
-
better now? luxor? ;-)
-
