Author Topic: What way should Documentation go?  (Read 13170 times)

0 Members and 1 Guest are viewing this topic.

Kevin

  • Global Moderator
  • Bigace Guru
  • *****
  • Posts: 3139
    • Kevin Papst
What way should Documentation go?
« on: January 23, 2007, 10:39:48 PM »
Hi Community!

I am asking myself - and today I am asking YOU - what we should do with the (User) Documentation.
There are often questions about a Help Document, to improve the Work of unexperienced users and the Answer is always (unfortunately):
"Not really existing".

Maybe, some of you do not ever have a look into a Help Document (I don't either), but a lot of not-technical Users do and it is an important for them, important for the acceptance and usabililty of the Software!

Till now, the current help version (that is shipped with BIGACE) is written in Docbook, a huge XML file, that can be converted in many different Output types (multiple HTML schemas, PDF...).
The current Version has many Articles only in German or English, some in both Languages and some only part translated.

As you can read, the current Status is disappointing  :(

It is hardly to add a new Language and it is nearly impossible to give the Community the chance to improve these documents.

Now I am looking for
  • ...a better and easier way of writing Documentation
  • ...people who are willing to spend some time with writing Documentation or simply with translation stuff

My questions
Do you know a System that we could use, not only for writing Documentation, but also for (simply) translating them into multiple languages as well?
The System should be able to export the Content into multiple Output types (at least HTML) and should allow the User to browse the Documentation online.
It should be easily possible to add, change, enhance and translate Documentation for User and should also have a archiving function to make sure no information get lost.

If you know such a System or if you have any other comment, please let me know! Give me some Ideas what WE could do....

Kevin  :)

Kevin

  • Global Moderator
  • Bigace Guru
  • *****
  • Posts: 3139
    • Kevin Papst
Re: What way should Documentation go?
« Reply #1 on: February 24, 2007, 02:27:08 PM »
WOW, not one comment in a month.

Please community, lets work together, in order to get BIGACE better and better!!!!

I cannot imagine, that you are not interested in any kind of documentation, aren't you?!

  ;D
« Last Edit: May 12, 2007, 12:33:06 AM by Kevin »

Kevin

  • Global Moderator
  • Bigace Guru
  • *****
  • Posts: 3139
    • Kevin Papst
Re: What way should Documentation go?
« Reply #2 on: May 12, 2007, 12:35:06 AM »
OKAY, I HAVE CHOOSEN BY MYSELF  :o

The new documentation is written with BIGACE with a wiki-like usage of Templates and Plugins.
Not everything is done yet, but the Website is up and installed, a Template was created and the old documentations content is being copied into the System.

I would be soooo glad to get any help, feedback ....

Kevin

nokiaman

  • Newbie
  • *
  • Posts: 5
Re: What way should Documentation go?
« Reply #3 on: November 05, 2007, 01:31:14 PM »
Hallo,
ich finde leider keine deutsche Doku (download wär super)
oder stell ich mich einfach blöd an?

gibts dieses Doku auch in Deutsch?

mfg
Nokiaman

Kevin

  • Global Moderator
  • Bigace Guru
  • *****
  • Posts: 3139
    • Kevin Papst
Re: What way should Documentation go?
« Reply #4 on: November 05, 2007, 01:41:28 PM »
Hi!

Nö, tut mir leid, was es an Doku gibt ist größtenteils in Englisch geschrieben (siehe http://wiki.bigace.de/).
Ne Deutsche Übersetzung wäre sehr wünschenswert, gibt es aber aktuell noch nicht.

Auch ein Donwload steht zur Zeit (noch) nicht zur Verfügung :(

Gruß Kevin