[Trisquel-devel] Documentation Set Project

[Flop Flop]

I like your proposal, it will help to structure contents and looks very professional. 

By the way, I wonder whether it would be possible to append automatically a note on all the current documentation pages indicating to potential translators that the best way is to ask for translation permissions in order to "add" a new translation or perhaps, if that is possible, to allow to any registered user the option of adding a new translation (through a button / link on the wiki). I myself made the mistake of editing the original page (English) and typing there the translation, which leads to loosing the original one and I observe it is happening again on several pages with the translations into other languages (French in this particular case). (e.g. http://trisquel.info/es/node/1625 or http://trisquel.info/en/wiki/dwyn).

Regards.

--- El vie, 2/4/10, Luis Felipe López Acevedo <introsmedia en gmail.com> escribió:

De: Luis Felipe López Acevedo <introsmedia en gmail.com>
Asunto: [Trisquel-devel] Documentation Set Project
Para: trisquel-devel en listas.trisquel.info
Fecha: viernes, 2 de abril, 2010 20:46

Hello all.

I'd like to help improve the documentation for Trisquel and I think we need to define some things before we start to write more documents:

1. Contents of the Documentation Set
2. Writing process

3. Where to start



1. Contents of the Documentation Set

First of all, I'd like to propose the following documentation set:

http://introsmedia.tuxfamily.org/lab/trisquel/docs/doc-system.html


As I say in the document above, that could be the main page that users would see when they click on the "Documentation" link in the website or when they go to "System → Help and Support" in the operating system.


I'm refering to users here, but since every user is a potential contributor, this documentation set also includes relevant information for anyone wondering how to contribute, and that's what the document at the end of the list is for. So, I see this main page as the entry point for anyone looking for information about Trisquel, its community, and its development process.




2. Writing process

I haven't thought much about this but my idea is that the writing process and the methodology used for other tasks such as artwork and development should be documented in the "Contributing Manual".


As we don't have any guidelines yet, I think we can start with a simple guideline based on what we have talked in #trisquel channel:

The main source for documentation would be the wiki and the default language would be English. Later, we could convert to DocBook any documentation we need to include in the system.




3. Where to start

I'm not familiar with the features of the wiki module for Drupal and I haven't found documentation for it, but I was thinking of leaving the current documentation as it is right now and start a new book in the wiki to define the new structure. Then, when the new structure is ready, we could start to reparent the current books and child pages.




What do you think?

-- 
Luis Felipe López Acevedo
http://introsmedia.tuxfamily.org/


-----Adjunto en línea a continuación-----

_______________________________________________
Trisquel-devel mailing list
Trisquel-devel en listas.trisquel.info
http://listas.trisquel.info/mailman/listinfo/trisquel-devel



      
------------ pr�xima parte ------------
Se ha borrado un adjunto en formato HTML...
URL: <http://listas.trisquel.info/pipermail/trisquel-devel/attachments/20100403/8fcc2bf3/attachment.htm>