RE: [Envolution-devel] eNvolution Documentation Project

[Denver P. Jr. <den...@co...>]

I hammered out 20+ english grammer mistakes in the current version if
they are still there in sourceforge cvs.  I've been away trying to get
osCommerce working with a huge mod to no avail.  I'll take a  break from
that and return to my duties in the team.  Can someone doing code fix
the user.php so that confirmation code is showed on the screen after
user/email prompt and adding form results hidden user name to the next
screen so all they have to do is enter the confirmation code?  I believe
once the code has been entered they should be taken to the user login
page.  The current form is just way to confusing for a user and very
tacky to have to hit the back browser just to enter in the confirm code.

-----Original Message-----
From: env...@li...
[mailto:env...@li...] On Behalf Of
Martin Luff
Sent: Tuesday, June 10, 2003 10:41 AM
To: env...@li...
Subject: Re: [Envolution-devel] eNvolution Documentation Project


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 ----- 
From: gagl <mailto:ca...@fr...>  
To: env...@li... 
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.....
 
  

eNvolution Documentation Project (eNDP)







This is the Team at this moment:

*	
General Documentation Manager: capretta (who else? Naphta, GatoNero?
Zoom?)

*	
Local Documentation Manager or Localization Director 

	- Italy: capretta

	- Germany: naphta, gatonero

	- France: philipc

	- English: ???

	- Other languages: ?????

*	
Staff writers: ??????????

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

************************************************************************
***

eNPD Vision and Proposition (eNPD Roadmap)

************************************************************************
***


eNDP Tasks: 

taken from the ENISS eNvo Organizational Structure Document of the
Founders

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

*	
Localization Manager: 

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.

*	
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: 


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. 







Roadmap




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

*	
Official Documentation: 

	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.

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

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

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

*	
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