Re: [Envolution-devel] eNvolution Documentation Project

[Martin L. <ma...@ar...>]

Hi Capretta

I'm happy to do English grammar/spelling check. Just let me know how you =
want me to do this.

Regards

Em
  ----- Original Message -----=20
  From: gagl=20
  To: env...@li...=20
  Sent: Tuesday, June 10, 2003 11:11 AM
  Subject: [Envolution-devel] eNvolution Documentation Project


  hi to evryone by capretta,
  that's the first proposal on eNDP (eNvolution Documentation Project)
  .....be eNvolved.....

   =20
  eNvolution Documentation Project (eNDP)







  This is the Team at this moment:

    a.. General Documentation Manager: capretta (who else? Naphta, =
GatoNero?  Zoom?)

    b.. Local Documentation Manager or Localization Director=20

    - Italy: capretta

    - Germany: naphta, gatonero

    - France: philipc

    - English: ???

    - Other languages: ?????

    c.. Staff writers: ??????????

    d.. Translators: ????????


  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.....)




  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

  =
*************************************************************************=
**

  eNPD Vision and Proposition (eNPD Roadmap)

  =
*************************************************************************=
**


  eNDP Tasks:=20

  taken from the ENISS eNvo Organizational Structure Document of the =
Founders

    a.. General Documentation Manager:

    This elected position is responsible to the Project Manager and the =
Founders. This position will require excellent communication skills and =
the ability to write documentation for both technical and non-technical =
users. The duties of this officer are, but not limited to:

  1)Document creation.

  2)FAQ's.

  3)Recruits and supervises content writers.

  4)Manages all published stories on the Envolution website.

  5)How-To and Tutorial creation and publication.

  This position requires daily interaction with the community and the =
Project Manager. This officer will also communicate with other officers =
to gain the required information to produce top quality documents for =
public consumption. Works directly with the Localization director to =
secure translations for the language specific support sites. This person =
should speak excellent English and have superior grammatical and =
spelling skills.

    a.. Localization Manager:=20

  This position is responsible for researching and implementing new =
languages and localizations for the entire project. This position =
answers directly to the Project Manager and the Founders (Specifically =
TiMax). This officer also tends to multilingual and translation duties =
for all project documentation. The officer must be prepared to interact =
daily with the community and the Documentation Manager. Duties are, but =
not limited to:

  1)Language translations.

  2)Document translations.

  3)Coordinating between various international support sites and the =
other officers and Founders of the project.

  4)Recruit non-English speaking people to interact with and/or join the =
project.

  5)Help with coordinating international web sites with the main =
Envolution web site.

  This position requires daily interaction with the community and the =
Project Manager as well as language specific support sites. This officer =
must be able to speak English and at least one other language. This =
officer should also expect to seek out other non-English speaking people =
to help with localization issues and support.

    a.. Translators: every localization has its team of translators from =
or into english, that has to be the basic language for the =
documentation. Translators fixed positions or occasional positions, =
covered for single projects.





  Technical Documents:=20


  Technical briefs are produced on a regular basis and are an invaluable =
source of information for you as a supporter of your localized =
Envolution Community. The subject matter is varied and covers all =
aspects of Envolution architecture, support, customization, features, =
announcements, bugs and comments.




  Documentation Tools and Formats




  All the official documentation can be produced using CVS (TiMax will =
create a directory for it, tell us where....) in HTML format. I =
personnaly use OpenOffice.org for it.

  Contributions and other team documentation could be produced using =
collaborative tools like Wiki.

  Pubblishing will be in PDF or HTML format in zip files for the =
Download Section and in HTML for on line versions (with Subjects Module, =
Content Express, etc.).




  Documentation License




  In our experience on eNvolution.it we learned to not use the Free =
Documentation License http://www.gnu.org/copyleft/fdl.html because we =
had some problems with irregular appropriation changing few words in the =
text. On envolution.it we use the 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







  Roadmap




    a.. On line manuals: of the Admin Panel localized in each =
/modules/..../lang/ directory as manual.html: some of these has to be =
written or updated. I will check which one are missing....

    a.. Official Documentation:=20

    Based on Zoom's Official eNvolution Manual, but with different =
structure and chapters updated or rewritten: for version 1.2.5 or 1.3

    - Part 1: Presentation of eNvolution (I have it almost ready in =
italian language, to be updated with the newest functions taken from =
"Who is envolution") with thumbnails of some representative eNvo sites

    - Part 2: Installation guide & basic settings : ( I have it also =
ready: local & remote installation for Win & Linux, upload to remote =
server, backup & dump, manual & script installation, basic configuration =
-> Settings in Admin Panel)

    - Part 3: Building your eNvo site: Layout : Naphta rewrote Sjah's =
manual....

    - Part 4: Advanced settings: we have to update Zoom's manual for =
module settings... some parts could be taken from other existing =
contributions.

    b.. Technical Documentation : most of it is still avaible on most =
sites: eNvo API, eNvRender, etc.

    c.. Localized Documentation : it's documentation produced from the =
specific countries to soddisfy internal needs: could be translated for =
similar needs of other countries

    d.. How to...and Tutorials: produced and translated from and for the =
whole Network, like modules guides, ....

    e.. Contributes: sent by eNvo supporters and users: to be translated =
if worthy.




  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. Other documentation can use both Wiki or HTML sent to =
translators.







  ciao,
  capretta