Antw: [Envolution-devel] eNvolution Documentation Project

[Stefan K. <Ste...@ga...>]

@capretta:
Please talk with naphta. He has begun with a first step for a manual on =
his private site with phpWiki.
I think we need some rules and guidelines for writers on all local sites. =
This is needed because everyone must know the new documentation structure, =
ie. chapters, contents, footnotes, etc.
I think at first we need a "table of contents" with all chapters and =
sub-chapters.
The best way to share and public our manual is, to write everything with =
phpWiki.
This tool is installed on eNvo.de, eNvo.com and eNvo.it I don't know if it =
is installed on eNvo.fr
These four languages are our premier langs. All others can follows later.

The technical documentation will be written (generate) with phpDocumentor. =
This tool is very good, but we need some definitions, rules and guidelines =
for all developers and coders.
phpDocumentor needs some special tags in the comments of the source code.
I will define it end of this week on this mailing list.

The complete staff list for all positions (managers, local managers, =
writers, translators, etc.) will follows also at end of week.
I will discuss some details with TiMax (and you) before.

It is absolutly necessary if we want to create this document over several =
local teams to find a uniform concept and all use the same tools.
=20
[...]
  a.. General Documentation Manager: capretta (who else? Naphta, GatoNero? =
 Zoom?)
[...]
No one else. One General Doc Manager is enough.

[...]
  b.. Local Documentation Manager or Localization Director=20
  - Italy: capretta
  - Germany: naphta, gatonero
  - France: philipc
  - English: ???
  - Other languages: ?????
[...]
All Local Docu Managers are your right hands. The LDM manage the complete =
docu in their primary langs.

[...]
We need first of all enghish-speaking overviewers, who only have to check =
my bad english grammar... This position controls the texts and articles =
before publishing for grammatical and language correction ( I have to do =
some english on-line courses.....)
[...]
I don't think so. Sure, we need overviewers, but it is not the primary =
task. Every LDM work autonom, which means, that I don't want to write ONE =
docu in ONE language and then translate it into the others.
This makes no sense.

[...]
This is only a proposal on how to organize and manage the documentation. =
Everyone feels free to contribute, discuss and add suggestions. It's a =
starting point in the hope others add to the team and fill vacant =
positions, so we can start with the project.=20
[...]
I agree if we use an open, public tool like phpWiki.

[...]
eNPD Vision and Proposition (eNPD Roadmap)
[...]
I agree with most of them. Some small details can be correct later, if we =
have defined the completly staff.

[...]
Documentation License
...
Open Document License http://www.opencontent.org/openpub/ where evrybody =
can use or distribute not for commercial use the document but has to leave =
original credits and can't modify without permission of the authors. All =
the documentation IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY.=20
[...]
I agree.


Your roadmap is perfect and well done.

[...]
The first two points has surely priority in the tasks roadmap. On line =
manuals need CVS production, for the official manual I propose to use also =
CVS.
[...]
Why CVS? We can also use phpWiki. It included also a versioning system =
like CVS. And it is a bit faster, because you can install it as module on =
every eNvo site.

[...]
Other documentation can use both Wiki or HTML sent to translators.
[...]
Translations are not needed if we organize the Docu team as I describe =
above.

WindMeUp







ciao,
capretta