documentation - discussion

krodelabestiole · Le 28/07/2017, à 16:28

je pense qu'il serait souhaitable de mettre en place un système de discussion sur les pages du wiki, comme ce qui se fait sur wikipedia.
ce plugin conviendrait bien je pense : https://www.dokuwiki.org/plugin:discussion
je ne sais pas du tout ou aller pour discuter des détails et on ne peut pas expliquer tous les choix dans les commentaires de publications.

dans le cas contraire un utilisateur un peu maniaque pourrait passer derrière et se plaindre à la fois qu'on fait trop de modifs

Roschan a écrit :

l'historique est illisible, que ce soit à cause de l'absurde quantité de révisions (15 en 1h ?!) ou à cause des \\ qui compactent artificiellement le code, en opposition aux recommandations de mise en page.

et qu'on ne précise pas assez de choses.
(ce sujet fait suite à ça : https://doc.ubuntu-fr.org/wsl?do=revisions )

bref du coup je viens parler d'un point à la fois un peu précis et général ici :

Roschan a écrit :

il est fantastiquement inutile et contraire aux recommendations de pourrir la page avec des \\ pour CHAQUE retour à la ligne.

soyons clair : \\ est traduit en html par un retour à la ligne <br>, deux sauts de ligne forment un nouveau paragraphe <p>

un nouveau paragraphe me semble signifier qu'on a fait le tour du point abordé et qu'on passe au point suivant.
de son côté, le <br> ne signifie rien. donc en principe on ne devrait pas l'utiliser (puisque le html doit être sémantique, selon le w3c).

sauf que la mise en page de la doc (et celle du site en général d'ailleurs, forum compris) me semble souffrir d'un grave problème.

Une suite de 45 à 75 caractères est communément considérée suffisante pour constituer la ligne d'un texte d'une colonne composé dans une fonte sans sérif. La ligne de 66 caractères (en comptant à la fois les lettres et les espaces) représente un idéal souvent utilisé. Pour un texte présenté en plusieurs colonnes, une moyenne de 40 à 50 caractères est plus appropriée.

http://webtypographie.net/2-1-2.php

c'est une règle typographique qui permet de gagner en lisibilité. sur un texte long par ex., on ne se trompe pas de ligne à la lecture en passant à la ligne suivante.
et ça permet de garder l'"élément texte" géolocalisé, dans ce qui ressemble à un rectangle.
hors sur la doc, le nombre de caractères par ligne tourne autour de 220 à 260 sur un écran full hd (et entre 500 et 600 sur un 4k, soit 10x trop).
ce qui fait que les paragraphes s'étirent à perte de vue sur la droite, et que la mise en page globale n'a l'air de rien.
il faudrait trouver un moyen de limiter l'élargissement des pages (css max-width).

en attendant pour parer à ce problème de mise en page et de lisibilité j'utilise le retour à la ligne à la fin de chaque phrase un peu longue.
comme là.

Dernière modification par krodelabestiole (Le 28/07/2017, à 16:34)

Roschan · Le 28/07/2017, à 16:57

Le moyen de discussion privilégié est pour l'instant la ML, mais paraît-il que ça va changer (?).

Je me fous plutôt du w3c pour le moment (et en terme de CSS, la largeur des boîtes n'est pas le seul souci du site, il y a tout à refaire). Il s'agit surtout d'avoir un code lisible par l'humain et maintenable, et pour cela il est conseillé qu'il respecte au mieux les règles de syntaxe décrites ici : https://doc.ubuntu-fr.org/wiki/syntaxe# … xte_simple
On a "fait le tour du point abordé et qu'on passe au point suivant" quand on... passe au point suivant ! les pages ont un plan et ce n'est pas pour faire joli.
Le \\ est à utiliser uniquement si c'est nécessaire, par exemple : vouloir faire des retours à la ligne dans un tableau, ou dans un même point d'une liste à puces. Dans tous les autres cas, on saute une ligne, c'est juste plus lisible, c'est tout.

Tout comme tes révisions successives pour +0, +2, +3 ou -8 octets, ça rend l'historique peu lisible donc il est plutôt conseillé d'utiliser l'aperçu, c'est du bon sens, pas besoin d'invoquer des théories typographiques.

L'Africain · Le 28/07/2017, à 17:03

Roschan a écrit :

Le moyen de discussion privilégié est pour l'instant la ML, mais paraît-il que ça va changer (?).

Non ça va pas changer. Bonne idée de rediriger vers la ml.

krodelabestiole · Le 28/07/2017, à 17:06

Roschan a écrit :

Je me fous plutôt du w3c pour le moment

tant mieux pour toi.

Roschan a écrit :

Le \\ est à utiliser uniquement si c'est nécessaire, par exemple : vouloir faire des retours à la ligne

exactement.

Roschan a écrit :

Tout comme tes révisions successives pour +0, +2, +3 ou -8 octets, ça rend l'historique peu lisible donc il est plutôt conseillé d'utiliser l'aperçu, c'est du bon sens, pas besoin d'invoquer des théories typographiques.

au contraire, en l'absence de plugin de discussions, plusieurs petites modifs permettent de documenter un minimum chaque changement.
c'est à l'outil d'historique lui-même de gérer le problème de lisibilité, peut-être en créant des "groupes" de changements en fonction des utilisateurs et de la timeline.

krodelabestiole · Le 28/07/2017, à 17:09

L'Africain a écrit :

Non ça va pas changer. Bonne idée de rediriger vers la ml.

j'ai jamais utilisé mais ça me semble pas très pratique comparé à une discussion sur chaque page.
et sauf erreur je ne vois aucun document ou aucun lien qui m'indique la direction de la ML quand j'édite une page.

krodelabestiole · Le 28/07/2017, à 17:16

Roschan a écrit :

On a "fait le tour du point abordé et qu'on passe au point suivant" quand on... passe au point suivant ! les pages ont un plan et ce n'est pas pour faire joli.

admettons que je parle de sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-point ?
il n'y a malheureusement pas de <h18> en html.
en plus de t'en foutre du w3c tu n'utilises jamais de paragraphe ?

Dernière modification par krodelabestiole (Le 28/07/2017, à 17:17)

krodelabestiole · Le 28/07/2017, à 17:21

krodelabestiole a écrit :

et sauf erreur je ne vois aucun document ou aucun lien qui m'indique la direction de la ML quand j'édite une page.

ok erreur :

4. Rapportez toutes créations ou modifications importantes sur la liste de discussion.

je vais tester

krodelabestiole · Le 28/07/2017, à 17:27

krodelabestiole a écrit :

j'ai jamais utilisé mais ça me semble pas très pratique comparé à une discussion sur chaque page.

mouais du coup c'est bien ce que je pensais : ça envoie des messages à tout le monde pour la moindre conversation entre 2 contributeurs, c'est long et fastidieux (pour pas dire impossible) de retrouver la discussion correspondante à une page ou une modification, etc.

Roschan · Le 28/07/2017, à 17:57

krodelabestiole a écrit :

Roschan a écrit :
On a "fait le tour du point abordé et qu'on passe au point suivant" quand on... passe au point suivant ! les pages ont un plan et ce n'est pas pour faire joli.
admettons que je parle de sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-sous-point ?
il n'y a malheureusement pas de <h18> en html.
en plus de t'en foutre du w3c tu n'utilises jamais de paragraphe ?

Si la page a besoin d'un niveau de titre h18, c'est qu'elle est très mal construite, et que certaines de ses sections nécessiterait une page ou un tutoriel dédié

krodelabestiole a écrit :

Roschan a écrit :
Le \\ est à utiliser uniquement si c'est nécessaire, par exemple : vouloir faire des retours à la ligne
exactement.

Hilarant.

krodelabestiole · Le 28/07/2017, à 18:22

tu es sérieusement en train de remettre en cause l'intérêt de la notion de paragraphe ?

Roschan · Le 28/07/2017, à 18:45

On n'écrit pas des thèses ni des romans, on fait des pages explicatives plus ou moins tutorielles afin de vulgariser une partie du logiciel libre à des débutants.

Si, avec des titres jusqu'à h5, tu as toujours besoin de limiter la notion de paragraphe à son aspect sémantique plutôt que de voir que c'est une question de clarté de la mise en page étant donné les limitations techniques du wiki, c'est uniquement toi qui remets en cause l'intérêt de la notion de mise en page

krodelabestiole · Le 28/07/2017, à 18:50

super. ben dans ce cas utilise seulement \\ sinon tu crées des paragraphes.

L'Africain · Le 28/07/2017, à 20:08

@ krodelabestiole, c'est sûr que la ML ce n'est pas parfait, je ne suis pas du tout contre le plugin en question, mais au sujet de la ML, il s'agit simplement d'organiser ses messages. Et le fait que toute la liste soit au courant est plutôt un atout. On est pas wikipédia, on a quelques messages de temps en temps. Pour l'instant grâce à collaboration de Roschan la liste est très active, mais il y a encore peu de temps j'étais pratiquement le seul à poster, pour demander conseils et avis...
Contribuer est plus utile que d'ergoter sur la manière de partager les contributions. Pour l'instant c'est la ML, il a aussi framateam, ce post, et pourquoi pas le plugin, mais dans l'immédiat faisons avec ce que l'on a et contribuons
Alors bienvenue sur la ML, il a du boulot sur la doc on a besoin de contributeurs.

bruno-legrand · Le 28/07/2017, à 20:32

Salut tout le monde

Je me permets d'intervenir également dans la discussion, si ça peut vous aider à réfléchir aux différentes possibilités, voici comment fait le site "debian-facile" pour son wiki;
Voici la page de documentation sur LibreOffice, qui mène comme on peut le voir sur la page vers un sujet dédié sur le forum, en effet en haut de la page il est écrit "Commentaires sur le forum", voici le sujet dédié à la page de documentation sur LibreOffice dans le forum (sujet qui se trouve dans une section dédiée du forum).
J'espère que cela peut être utile à vos réflexions.

krodelabestiole · Le 28/07/2017, à 22:40

bruno-legrand a écrit :

Voici la page de documentation sur LibreOffice, qui mène comme on peut le voir sur la page vers un sujet dédié sur le forum

ça me parait être une excellente solution !
en plus les outils sont déjà en place.
une section sur le forum dédiée à la doc avec un sujet par page (à créer en cas de nécessité) et un lien sur la page en question (discret : c'est que pour les contributeurs), et on oublie la mailing list.
pas d'inscription supplémentaire, de tonnes d'emails sur toutes les boîtes, de discussions passées introuvables...

est-ce que ça vous semble souhaitable et envisageable ?

Dernière modification par krodelabestiole (Le 28/07/2017, à 22:44)

L'Africain · Le 29/07/2017, à 11:56

Qu'on oublie la ML ça je doute...
Pour le reste ma foi j'y suis pas opposé mais faut pas croire que c'est la solution miracle, parce qu'avec ce mode de fonctionnement ce sont que les personnes intéressées qui sont au courant de ce qui s'y passe alors qu'avec la ML tout le monde est au courant, ça permet de suivre l'ensemble.

bruno-legrand · Le 29/07/2017, à 12:38

L'Africain a écrit :

avec ce mode de fonctionnement ce sont que les personnes intéressées qui sont au courant de ce qui s'y passe alors qu'avec la ML tout le monde est au courant, ça permet de suivre l'ensemble.

De ma vision des choses c'est équivalent, voir un peu plus simple avec le forum; Pour voir ce qui se passe dans la mailing-list, il faut y être inscrit; Pour voir ce qui se passe par rapport à tel ou tel page de doc, on regarde son sujet dédié sur le forum (en étant inscrit au forum ou non d'ailleurs).
Et puisque avec le forum vous pouvez faire un sujet par page, cela rend le suivi des discussions par rapports aux pages plus facilement trouvable. D'autant que dans ce cas le mieux est d’avoir comme debian-facile une section du forum dédiée.
Ce n'est que ma vision des choses, et j'essaye juste de vous aider dans vos réflexions (en tant que non contributeur à la doc en plus).

L'Africain · Le 29/07/2017, à 16:34

@bruno-legrand,
Non tu as bien fait de nous partager votre expérience. Je crois qu'on est un peut dans nos préférences conditionnées par nos habitudes. Perso, je suis plus a l'aise avec la ML, le forum et framateam, est la solution la moins conviviale pour moi.
J'aime l'idée de centralisation via la ML.
Mais comme je l'ai dit j'ai rien contre la proposition ! Sauf que cela fera un outil de plus qu'il faudra suivre... Encore du travail... Les admins prennent déjà en charge sympa, les modifs de la doc sur une adresse, la ML, framateam... S'il y avait 20 admins ça serait cool... Mais c'est pas encore le cas, or pour être admin il faut contribuer pour qu'on vous remarque... Alors contribuez

bruno-legrand · Le 29/07/2017, à 17:12

Est-ce que cela ferait vraiment un outil en + dont il faudrait s'occuper ?

Le forum est déjà géré actuellement, la documentation l'est aussi, ce qui changerai ce serait qu'une page de documentation aurait un lien vers son sujet dédié dans le forum;
Donc juste à faire un sujet dédié et mettre le lien dans la page de documentation.

Les admin aurait à gérer moins de mailing-list (moins puisque j'ai vu sur le site ubuntu-fr qu'il y en a plusieurs), puisque si vous prendriez cette solution, la mailing-list de documentation serait inutile à terme. Un truc de moins à gérer.

édit : là aussi ce serait centralisé, chaque page aurait son propre sujet dédié, dans une section du forum dédiée.

Ce qui est sûr par contre c'est que si vous faites ça (un sujet dédié sur le forum par page de documentation), cela va faire un peu plus de charge sur votre serveur puisque il faudrait faire énormément de sujets pour couvrir toute votre doc. Après je ne m'y connais pas en serveur et donc je ne sais pas si cela influerai vraiment en terme de charge/poids sur lui.

Dernière modification par bruno-legrand (Le 29/07/2017, à 17:14)

krodelabestiole · Le 29/07/2017, à 17:34

L'Africain a écrit :

Je crois qu'on est un peut dans nos préférences conditionnées par nos habitudes

oui mais il faut faire gaffe à ça. je pense que l'utilisation d'un outil mal adapté peut-être rédhibitoire pour un nouvel utilisateur (ça l'est pour moi).
je n'ai pas envie d'envoyer un mass mailing pour chaque petite interrogation que je peux avoir, j'ai du mal à me faire une idée des bonnes pratiques dans le domaine ou à trouver des informations à ce sujet, etc. (+ les raisons déjà évoquées de recherche de discussion en fonction de la page qui me semble assez capitales)
je pense que davantage de personnes comprennent le fonctionnement (et les bonnes habitudes) d'un forum que le fonctionnement d'une mailing list. tout ça est plus visible.

L'Africain a écrit :

avec la ML tout le monde est au courant, ça permet de suivre l'ensemble

sur le forum il y a un bouton "suivre ce forum" qui permet de recevoir des emails pour chaque nouveau sujet. on peut y souscrire si on en a envie, mais je pense que c'est plus simple de simplement consulter le forum quand on a le temps de s'en occuper, au lieu de recevoir un flux continu d'informations dans sa boîte alors qu'on a autre chose à faire.

L'Africain a écrit :

Mais comme je l'ai dit j'ai rien contre la proposition ! Sauf que cela fera un outil de plus qu'il faudra suivre..

comme dit bruno-legrand, il me semble que c'est plutôt un outil de moins.

bruno-legrand a écrit :

cela va faire un peu plus de charge sur votre serveur puisque il faudrait faire énormément de sujets pour couvrir toute votre doc

il me semble qu'on peut aussi décider de ne créer ces pages qu'en cas de nécessité. ça n'est pas forcément la peine de créer des sujets vides.

?? · Le 29/07/2017, à 17:56

Bonjour

Roschan a écrit :

Tout comme tes révisions successives pour +0, +2, +3 ou -8 octets, ça rend l'historique peu lisible donc il est plutôt conseillé d'utiliser l'aperçu, c'est du bon sens, pas besoin d'invoquer des théories typographiques.

Vous n'avez qu'à développer la fonctionnalité "brouillon" puis "valider mon brouillon" et d'ailleurs pas qu'à cet endroit!!!!!.
Le lieu de stockage ne doit pas être le micro de l'utilisateur qui est sujet à des déconnexions avec perte de ce qu'il a préparé.

Dernière modification par ?? (Le 29/07/2017, à 18:07)

krodelabestiole · Le 29/07/2017, à 20:09

oui en plus dans le cas contraire on indique quoi dans les commentaires d'édition ? "modifications diverses et variées" ?

... sans trop m'avancer je pense pas que ça fasse gagner en lisibilité côté historique.

L'Africain · Le 30/07/2017, à 08:50

krodelabestiole a écrit :

l'utilisation d'un outil mal adapté peut-être rédhibitoire pour un nouvel utilisateur (ça l'est pour moi).

C'est ton avis.

krodelabestiole a écrit :

au lieu de recevoir un flux continu d'informations

On voit que tu n'es pas abonné à la ML, je t'avoue qu'avant qu'on relance le travail de la doc, c'était très très calme côté ML, j'attends avec impatience qu'on ai un flux continu d'information...

Roschan · Le 30/07/2017, à 08:57

?? a écrit :

Bonjour
Roschan a écrit :
Tout comme tes révisions successives pour +0, +2, +3 ou -8 octets, ça rend l'historique peu lisible donc il est plutôt conseillé d'utiliser l'aperçu, c'est du bon sens, pas besoin d'invoquer des théories typographiques.
Vous n'avez qu'à développer la fonctionnalité "brouillon" puis "valider mon brouillon" et d'ailleurs pas qu'à cet endroit!!!!!.
Le lieu de stockage ne doit pas être le micro de l'utilisateur qui est sujet à des déconnexions avec perte de ce qu'il a préparé.

Sur le forum c'est impossible de rester connecté, mais sur la doc ça fait 2 mois que je n'ai pas rentré mon mot de passe tellement ça marche bien.
Le "brouillon" c'est la fonctionnalité "Aperçu", les choses qu'on tape sont d'ailleurs normalement mémorisées par le site en cas de déconnexion intempestive

Aldian · Le 30/07/2017, à 09:29

Salut, pour ceux qui ne me connaissent pas je fais partie des administrateurs de la doc. Je vais essayer d'apporter des réponses sur quelques points:

1) Retours à la ligne
Sur ce point, il est effectivement demandé de ne pas abuser de la balise de retour. Dans un très grand nombre de cas, un saut de ligne suffit pour distinguer des paragraphes. Et s'il s'avère nécessaire de distinguer mieux les paragraphes, peut être qu'une sous partie est manquante. Pour élargir la discussion, je voudrais pointer en avant le fait que les outils d'export gèrent généralement beaucoup plus mal les retours à la ligne manuel qu'une organisation de document basée sur des paragraphes organisés avec titres et sous titres

2) Onglet discussion
J'en suis également partisan. Mais comment dire, on ne peut pas être partout et il y a des chantiers plus urgents. Par exemple cette semaine nous avons upgradé le moteur de la doc. Le prochain chantier est le passage en responsive design. L'onglet discussion, fait débat pour sa part car les gens ont peur que les contributeurs ne viennent plus jamais sur la mailing list, mais peut être qu'on finira par réussir à se mettre d'accord. En attendant pour faire avancer les choses, le plus simple est de passer de l'étape où vous nous dites quoi faire à l'étape où vous venez nous aider à le faire.

3) Mailing List vs forum
Les gens qui n'aiment pas les mailing list sont généralement ceux qui ne savent pas se servir d'une boite mail moderne. Car il suffit de faire un filtre sur les messages de la liste pour les envoyer dans le bon dossier automatiquement. Ca ne prend pas de place au regard de la place qu'on a aujourd'hui dans les boites mails. Il y a au max une dizaine de messages par jour on n'est pas noyé. Enfin, et c'est ce que la plupart des gens apprécient vis à vis d'un forum, ça fait un outil de moins et on n'est pas obligé d'aller chercher l'information: elle vient à nous. Ca fait gagner du temps et c'est moins fastidieux.

Et pour finir, merci d'éviter le troll gratuit et les propos agressifs

Dernière modification par Aldian (Le 30/07/2017, à 09:32)

Ubuntu-fr

Navigation

Liens de recherche

Annonce

#1 Le 28/07/2017, à 16:28

documentation - discussion

#2 Le 28/07/2017, à 16:57

Re : documentation - discussion

#3 Le 28/07/2017, à 17:03

Re : documentation - discussion

#4 Le 28/07/2017, à 17:06

Re : documentation - discussion

#5 Le 28/07/2017, à 17:09

Re : documentation - discussion

#6 Le 28/07/2017, à 17:16

Re : documentation - discussion

#7 Le 28/07/2017, à 17:21

Re : documentation - discussion

#8 Le 28/07/2017, à 17:27

Re : documentation - discussion

#9 Le 28/07/2017, à 17:57

Re : documentation - discussion

#10 Le 28/07/2017, à 18:22

Re : documentation - discussion

#11 Le 28/07/2017, à 18:45

Re : documentation - discussion

#12 Le 28/07/2017, à 18:50

Re : documentation - discussion

#13 Le 28/07/2017, à 20:08

Re : documentation - discussion

#14 Le 28/07/2017, à 20:32

Re : documentation - discussion

#15 Le 28/07/2017, à 22:40

Re : documentation - discussion

#16 Le 29/07/2017, à 11:56

Re : documentation - discussion

#17 Le 29/07/2017, à 12:38

Re : documentation - discussion

#18 Le 29/07/2017, à 16:34

Re : documentation - discussion

#19 Le 29/07/2017, à 17:12

Re : documentation - discussion

#20 Le 29/07/2017, à 17:34

Re : documentation - discussion

#21 Le 29/07/2017, à 17:56

Re : documentation - discussion

#22 Le 29/07/2017, à 20:09

Re : documentation - discussion

#23 Le 30/07/2017, à 08:50

Re : documentation - discussion

#24 Le 30/07/2017, à 08:57

Re : documentation - discussion

#25 Le 30/07/2017, à 09:29

Re : documentation - discussion

Pied de page des forums