Xaraya NL teams and docs effort

Artem <[email protected]> Mon, 8 Mar 2004 11:35:35 +0300
Newsgroups gmane.comp.cms.xaraya.documentation
Message-ID <[email protected]>
Hello, xaraya.

We'd like to rise an issue about interaction of Xaraya National
Support Teams in the field of Xaraya's docs creation.

We hope it is right place to post.

In general.

Due to practical unreality of creation good docs in the nearest future
(read - in medium-term outlook) we'd like to call attention to think
about REAL steps forward to creation the docs. And as the main point
on this way should be collaboration of all NL teams. We don't believe
(based on PostNuke experience) in possibility of writing docs by small
group of people. As always, in spite of understanding high importance
of docs by developers, coding is on foreground instead of docs :)

How we're seeing it.

Assuming that elementary chapters of docs such as Installation & First
Settings are already translated or wrote (at least in Russian) it is
necessary to start work on collecting and processing information about
functionality of various parts of Xaraya system. It's giant job for
all Xaraya community but not for devs & enthusiasts only.

In the first glance it could be started in the following way:

1. NL teams translate and publish on NL sites Modules Overviews based
on existing ones for admins (most part of this work should be already
done during locale translation).  

2. Those Overviews could be published in special categories of NL
sites (should be discussed), e.g.: 

- Overview of Xaraya modules
-- Core Modules 
---- Module 1... 
-- Utility Modules 
---- Module 1...
-- Content Modules
---- Module 1...
-- Miscellaneous Modules 
---- Module 1...

3. Every translator could add a few words to Overviews because during
translation they most likely tested main features of the modules, we
guess.  

4. NL teams could encourage their users to comment on those articles
some tricks, tips and usability they found in modules (at least in our
dreams :-D).  

5. NL teams leaders can translate most useful and interesting comments
and post it on the same article on Xaraya.com (or whatever else but in
one and structured place).  

6. From time to time someone from devs could process collected info
and formalize it into the docs. At least try. 

It might looks like Knowledge Base analog but more structured,
centralized and connected to experience of many people speaking on
many languages.  

It just one of the many possible ways to achieve good docs. Sure, we
could see many nice thoughts in discussion of this issue but we should
start to do something to be able to get them. At least discuss it :)  

On behalf of Russian Xaraya Team,
Artem