[Défi] Grand ménage de la Documentation.

billou · Le 07/06/2008, à 18:00

Salut tout le monde, j'aimerais proposer aux ubuntéros qui s'ennuient devant leur écran, ou aux intéressés, un grand nettoyage de la documentation
Le principe serait simple, à partir de l'accueil, naviguer dans les diverses catégories, repérer les anomalie, et les corriger.
Les anomalies peuvent être d'origine orthographique, grammaticales, une question d'organisation, de clarté, de légalité, de vétusté , et surtout d'équivalence (indiquer les manips graphiques ET en ligne de commande), etc...

De par la consultation du wiki, j'ai pu remarquer quelques principaux problèmes.

-L'organisation des catégories (certains tutoriels sont introuvables en regardant sois même la doc, sans passer par une recherche google, à cause de titres mal formatés, ou autre, pire parfois à cause de ce genre de choses, il existe plusieurs pages différentes pour un même tutoriel.

-La mise à jour des tutoriels, mais généralement c'est un souci durant peu de temps

-Le manque de tutoriels sur les manipulation de base, beaucoup de choses simples à faire ne sont indiqués que concernant une interface graphique, mettant de ce fait aux oubliettes la solution ligne de commandes, qui pourtant peu parfois vous sauver la mise pour une raison ou une autre.

-Les problèmes de clarté concernant la ligne de commande quand les manipulation sont indiquée, un exemple simple "éditez /etc/apt/sources.list" , ou rien ne sera indiqué concernant le besoin d'utiliser gksudo et sudo, ou nano et gedit, concernant la manipulation, chose qui pourrait dérouter le débutant.

-Le manque de capture d'écran et de logos des programmes (pour un débutant, c'est déroutant de ne pas avoir le screen d'un logiciel, avant de tenter de l'utiliser, l'apparence est un critère primordial pour celui qui s'interesse à quelque chose)

-Pas assez de clarté sur le système de droit, d'exécution de programmes, l'inutilité des extensions de fichier, les fichiers cachés, la compilation et le gestionnaire de paquet, la gestion des drivers, l'utilité d'une partition SWAP, l'utilité de la ligne de commandes, le format des partition, lorsqu'un utilisateur voudra se renseigner pour la 1ere fois sur la documentation et savoir de quelle manière aborder un système GNU/Linux, ce sont des bases nécessaires à connaître concernant la façon de fonctionner du système pour toute future manipulation, et un utilisateur venant d'un autre système, s'intéressant à GNU/Linux ne peut pas savoir tout ça, à moins d'avoir arpenté pendant des heures le forum et la documentation, afin de pouvoir acquérir les connaissances de bases.

Sur ce dernier point, c'est l'exemple même de ce qui m'avais empêché de passer sous un système GNU/Linux depuis des années, bien qu'ayant essayé Mandriva et Debian, je n'accrochais pas, car je pensais en tant que windowsien, qu'il fallait télécharger des programmes, et je me retrouvais avec des sources, à compiler (bonjour la galère).
Ensuite pensant que "root" était simplement un compte administrateur nécessaire comme sous windows, je petais un cable à tenter de modifier des fichiers dans le système, ou d'y acceder, et de me retrouver avec une tonne d'erreurs... D'accès interdits...

C'est pourquoi j'ai écrit il y a quelques temps ce tutoriel concernant les différentes façon d'installer des logiciels, dont j'autorise totalement la reprise, pour la documentation ou autre, si besoin est.

N'hésitons plus à participer à l'élaboration de ce wiki, pour en faire quelque chose de meilleur !
N'hésitez pas à rapporter vos créations et diverses modifications à la suite de ce message.

Mesdemoiselles, Mesdames, Messieurs, le débat est ouvert !

N'hésitez pas à exprimer votre point de vue, en bien ou en mal !

Dernière modification par billou (Le 07/06/2008, à 18:01)

michel2652 · Le 07/06/2008, à 18:11

Bonjour,

Pensez à lire Comment participer à l'élaboration de cette documentation ? et Coordination de la documentation.

A+

xabilon · Le 07/06/2008, à 18:38

michel2652 a écrit :

Bonjour,
Pensez à lire Comment participer à l'élaboration de cette documentation ? et Coordination de la documentation.
A+

Pas mieux

Danzisso · Le 07/06/2008, à 18:46

A mes yeux la plus grande priorité c'est indiquer les versions concernées.
Dire pour lesquelles la manip décrite est possible/nécessaire, et pourquoi pas dans chaque page de manuel des onglets "Hardy", "feisty", gutsy", etc, certains onglets rpointant sur la même page si la manip est la même pour plusieurs versions
Parce qu'en tant que nouveau débarqué 2 jours après Hardy, je sais pas trop quand je dois suivre la doc, et quand surtout pas...

xabilon · Le 07/06/2008, à 18:51

Danzisso a écrit :

et pourquoi pas dans chaque page de manuel des onglets "Hardy", "feisty", gutsy", etc, certains onglets rpointant sur la même page si la manip est la même pour plusieurs versions

En voilà une idée qu'elle est pas bête ! Ce qui simplifierait en plus le nettoyage des versions obsolètes.

Ya plus qu'à demander sur la mailing-list si dokuwiki permet de faire ça.

billou · Le 07/06/2008, à 19:22

là je répond +1 pour le système d'onglets !!

ça permettrais de faire quelque chose de plus propre, et de conserver les tutoriels d'anciennes versions

Danzisso · Le 07/06/2008, à 21:11

Je vous laisse demander, avec les histoires de docuwiki et tout, me brusquez pas trop, je suis encore un bleu !

billou · Le 07/06/2008, à 22:51

Ce n'est pas auprès de Dokuwiki qu'il faut demander cette fonction, mais auprès de la team Ubuntu-Fr, Dokuwiki étant Open-Source, la team n'aura plus qu'à leur faire part des modifications effectuées pour pouvoir si nécessaire créer un Mod ou un Plugin pour le script

mr_pouit · Le 07/06/2008, à 23:12

Ouais, enfin si tu trouves quelqu'un de la team qui a suffisamment de temps pour le faire ^^"

Astrolivier · Le 08/06/2008, à 05:51

salut,

je vais bientôt arriver en correction d'exam donc je suis encore bien occupé pendant deux-trois semaines, par contre après j'ai pas mal de temps libre et je commence mon propre dokuwiki. Je débute, mais aider dans la doc de ce site me permettra de progresser et de pouvoir me faire de bonnes bases pour monmien.

voilà disons que je suis motivé donc à bientôt

billou · Le 08/06/2008, à 10:04

Salut Astrolivier, si besoin est je peux t'aider en te donnant accès à un espace FTP et une base de donnée

Astrolivier · Le 08/06/2008, à 10:28

@billou : pour mon dokuwiki ? pour l'instant il est en localhost, et va certainement le rester jusqu'en septembre prochain. en fait c'est mes cours pour mes étudiants. Mais c'est gentil peut être en temps voulu

Xarkam · Le 08/06/2008, à 13:43

Les onglets je pense pas que cela fonctionne.
Par contre comme j'avais déjà qui il y a longtemps, Ubuntu se veux une distribution simple.
L'accueil du wiki fr quant on tombe dessus, c'est tout sauf une page clair et concise.

Il y a bien 4-5 sections qui on attrait à des procédures plus avancées ou bien qui parlent de choses qui devraient se trouver dans une/des page(s) de sous accueil.

Par contre pour pallier aux onglet je verrais bien un plugin de div repliable.
Il faudrait voir aussi à avoir des logo ubuntu avec le numéro majeur de version dedans.

Je ferais une page exemple dans la semaine avec les images histoire de bien faire comprendre ma pensée

Slystone · Le 08/06/2008, à 22:11

Est-ce que t'inclus dans les manipulations de base l'usage de la console et à un niveau plus avancé l'introduction aux scripts shell ? (je crois qu'on est quelques uns à trouver dur de franchir l'étape qu'il y a entre le simple utilisateur de base, et celui qui sait se servir du terminal, éditer ses fichiers de confs, programmer en shell...)
Quelqu'un demandait justement des cours shell, et après indication du lien vers le siteduzero j'ai vu dans la doc que celui-ci n'était pas renseigné.
Voilà tout ce que je peux dire, à mon petit niveau je ne vois pas trop l'aide que je pourrai apporter cet été sinon. Bon courage

YannUbuntu · Le 16/06/2008, à 07:40

Bonjour à tous,

Tres bonne idée que d'améliorer la documentation. Quitte à parler de modifications structurelles (comme les onglets):

Moi il y a un truc qui m'étonne au plus haut point, c'est que notre wiki n'utilise pas ce qui fait la force d'un vrai wiki (genre Wikipedia), par exemple:
* Il manque les liens de langues dans le menu a gauche. A quoi ca sert me direz-vous? Eh bien ca sert à profiter du retour d'expérience (via leurs documentations) de millions d'utilisateurs non-francophones !!! Et pour ceux qui disent "mais moi je parle pas anglais", je leur répond qu'il y a des centaines de traducteurs bénévoles comme moi qui n'attendent que ces liens pour améliorer les pages francophones! Et pour ceux qui disent: "oui mais tu peux mettre les liens de langue en bas de la page", ok mais c'est ni propre ni efficace ni standardisable internationalement...
* Impossible de comparer deux pages de l'historique entre elles. Vraiment pas pratique pour savoir qui a écrit quoi... surtout pour les thèmes polémiques et pour détecter les spams.
* La je me trompe peut-être mais je crois que l'historique des pages est limité.

Ces remarques s'adressent bien entendu aux admins ubuntu-fr, mais j'aimerais bien avoir votre avis à tous

AlexandreP · Le 16/06/2008, à 15:21

YannUbuntu a écrit :

Moi il y a un truc qui m'étonne au plus haut point, c'est que notre wiki n'utilise pas ce qui fait la force d'un vrai wiki (genre Wikipedia), par exemple:
* Il manque les liens de langues dans le menu a gauche. A quoi ca sert me direz-vous? Eh bien ca sert à profiter du retour d'expérience (via leurs documentations) de millions d'utilisateurs non-francophones !!! Et pour ceux qui disent "mais moi je parle pas anglais", je leur répond qu'il y a des centaines de traducteurs bénévoles comme moi qui n'attendent que ces liens pour améliorer les pages francophones! Et pour ceux qui disent: "oui mais tu peux mettre les liens de langue en bas de la page", ok mais c'est ni propre ni efficace ni standardisable internationalement...

La différence est que Wikipedia est une encyclopédie multilingue à la base : dans sa structure, elle prévoit que des sujets sont traités selon toutes les langues. Ubuntu-FR se veut être une documentation francophone uniquement à la base, qui utilise un moteur différent de celui utilisé dans le site officiel d'Ubuntu.

YannUbuntu a écrit :

* Impossible de comparer deux pages de l'historique entre elles. Vraiment pas pratique pour savoir qui a écrit quoi... surtout pour les thèmes polémiques et pour détecter les spams.

On peut comparer une page d'historique et la page actuellement publiée. On ne peut pas comparer deux pages d'historique entre elles.

xabilon · Le 16/06/2008, à 16:09

YannUbuntu a écrit :

* Impossible de comparer deux pages de l'historique entre elles. Vraiment pas pratique pour savoir qui a écrit quoi... surtout pour les thèmes polémiques et pour détecter les spams.

Ouais ... je vois pas ce qu'il pourrait y avoir de polémique dans une documentation ... ce qui s'en est rapproché le plus, c'est un mini-débat au sujet de l'utilisation de apt-get ou aptitude. La subjectivité est évitée la plupart du temps.

Un spam ou un vandalisme est habituellement facilement détectable et corrigible.
Si c'est plus vicieux (genre une commande dangereuse camouflée dans une ligne de commande), il faudra quand même que quelqu'un vérifie toutes les pages et soit en mesure d'identifier une éventuelle malveillance dans la modification ---> le système actuel revient au même

YannUbuntu · Le 16/06/2008, à 16:10

Bonjour Alexandre,
tu confirmes donc bien qu'il manque des fonctionnalités au wiki ubuntu-fr
Puisque c'est une histoire de moteur wiki:
1) Peut-on ajouter les fonctionnalités manquantes via des plugins de DocuWiki (le moteur du wiki ubuntu-fr) ?
2) Sinon, est-il possible de migrer "facilement" vers un moteur qui permette ces fonctionnalités? (désolé pour mon ignorance sur ce sujet, je ne connais que MediaWiki, mais il y a peut-être des macros qui modifient automatiquement la syntaxe des pages pour des migrations? )

EDIT: je viens de trouver ce plugin qui permettrait d'ajouter les liens de langues, par contre je cherche toujours pour la comparaison des versions de l'historique...

Dernière modification par YannUbuntu (Le 16/06/2008, à 16:31)

Yann · Le 16/06/2008, à 23:01

YannUbuntu > c est plus complique que ca.. les autres locos utilisent toutes des wiki differents... ensuite pour comparer les versions ca vient dans la derniere version de doku et la mise est jour est prevue et imminente

YannUbuntu · Le 17/06/2008, à 07:16

Cool Dès que l'ajout de liens de langues est possible, previens-moi stp j'organiserai un groupe de travail pour ajouter les liens anglais (puis esp/all/..) sur les pages les plus importantes.
A partir de là, on pourra dresser une liste de pages à mettre à jour (celles où les pages anglaises sont plus documentées que les pages françaises).

billou · Le 17/06/2008, à 13:39

Hé bha, je vois que ça discute ici, j'étais pas passé depuis un moment
Entre la possibilité d'inclure plusieurs langues, et celle de rajouter des onglets pour permettre la possibilité de dedier une page pour chaque version D'ubuntu, ça en jetterais !

Fred-Prague · Le 17/06/2008, à 14:42

Bonjour,

Je ne sais pas si eux-mêmes ont repris la doc anglophone mais la documentation en tchèque est très bien faite. D'accord, peu de gens ici comprennent le tchèque mais rien que la présentation est très claire, sobre (Gnomesque?).

En ce qui concerne le contenu si je trouve des choses bien qui manquent ici, je veux bien faire des traductions mais pas tout de suite (cet été?).

Dernière modification par Fred-Prague (Le 17/06/2008, à 14:43)

YannUbuntu · Le 17/06/2008, à 19:06

Je sens que les liens de traduction ont un gros potentiel améliorer notre Documentation

@billou : moi j'aime bien ton tuto, c'est clair, illustré. En tout cas, c'est ce que j'aurais voulu trouver à cet endroit de la page d'accueil de la Documentation à la place de " Gestionnaire de paquets" quand j'ai débuté sur Ubuntu. Bref, la doc actuelle mériterait quelques screenshots...

@tous : Au niveau des actions à entreprendre pour notre "Grand ménage de la Documentation", je pense que les idées de billou sont bonnes.

Je propose de commencer par :
1) l'ajout des liens explicatifs ("installer_un_paquet", "editer")& captures d'écran sur les pages les plus lues par les débutants (par exemple toutes celles qui ont un lien sur la page d'accueil de la Doc)
2) puis comme le sous-entend Fred-Prague, rendre la page d'accueil de la Doc plus synthétique (il y a un vote en cours à ce sujet) . Notamment, prendre un ordre logique: avant l'installation, comment installer, après l'installation.
3) ensuite jeter un oeil sur les pages qui ont le tag "BROUILLON"

AlexandreP · Le 17/06/2008, à 21:46

Vous avez envie de participer à l'élaboration / amélioration de la documentation du site, en proposant des idées et/ou mettre la main à la pâte ? Abonnez-vous à la liste de diffusion "Coordination de la documentation" ! C'est là que toute l'action se passe et devrait se passer.

Ubuntu-fr

Navigation

Liens de recherche

Annonce

#1 Le 07/06/2008, à 18:00

[Défi] Grand ménage de la Documentation.

#2 Le 07/06/2008, à 18:11

Re : [Défi] Grand ménage de la Documentation.

#3 Le 07/06/2008, à 18:38

Re : [Défi] Grand ménage de la Documentation.

#4 Le 07/06/2008, à 18:46

Re : [Défi] Grand ménage de la Documentation.

#5 Le 07/06/2008, à 18:51

Re : [Défi] Grand ménage de la Documentation.

#6 Le 07/06/2008, à 19:22

Re : [Défi] Grand ménage de la Documentation.

#7 Le 07/06/2008, à 21:11

Re : [Défi] Grand ménage de la Documentation.

#8 Le 07/06/2008, à 22:51

Re : [Défi] Grand ménage de la Documentation.

#9 Le 07/06/2008, à 23:12

Re : [Défi] Grand ménage de la Documentation.

#10 Le 08/06/2008, à 05:51

Re : [Défi] Grand ménage de la Documentation.

#11 Le 08/06/2008, à 10:04

Re : [Défi] Grand ménage de la Documentation.

#12 Le 08/06/2008, à 10:28

Re : [Défi] Grand ménage de la Documentation.

#13 Le 08/06/2008, à 13:43

Re : [Défi] Grand ménage de la Documentation.

#14 Le 08/06/2008, à 22:11

Re : [Défi] Grand ménage de la Documentation.

#15 Le 16/06/2008, à 07:40

Re : [Défi] Grand ménage de la Documentation.

#16 Le 16/06/2008, à 15:21

Re : [Défi] Grand ménage de la Documentation.

#17 Le 16/06/2008, à 16:09

Re : [Défi] Grand ménage de la Documentation.

#18 Le 16/06/2008, à 16:10

Re : [Défi] Grand ménage de la Documentation.

#19 Le 16/06/2008, à 23:01

Re : [Défi] Grand ménage de la Documentation.

#20 Le 17/06/2008, à 07:16

Re : [Défi] Grand ménage de la Documentation.

#21 Le 17/06/2008, à 13:39

Re : [Défi] Grand ménage de la Documentation.

#22 Le 17/06/2008, à 14:42

Re : [Défi] Grand ménage de la Documentation.

#23 Le 17/06/2008, à 19:06

Re : [Défi] Grand ménage de la Documentation.

#24 Le 17/06/2008, à 21:46

Re : [Défi] Grand ménage de la Documentation.

Pied de page des forums