Forum

Hello tous les membres de PHPBoost!

Voila on aurait bien besoin de quelques membres pour m'aider dans la documentation! C'est bien beau vous allez me dire, mais pourquoi rédiger des documentations? Qu'est ce que cela apporte? Quelles sont les conditions pour entrer dans l'équipe?

Pourquoi rédiger des documentations?

Tout d'abord, je tiens à préciser que tout projet a besoin d'une documentation la plus complète. Avez vous déjà acheté un logiciel, un appareil ménager,... Bizarre il y a toujours un petit livret inclus avec : la documentation!!! Et oui, ce 'machin' que bien souvent personne ne lit est là pour expliquer le fonctionnement du produit ainsi que ses subtilités (et cela sert je vous assure!!!) Et PHPBoost n'est pas une exception à la règle!

Qu'est ce que cela apporte?

Euh n'attendez pas la médaille de la plus haute distinction (faut pas rêver non plus )
Pour cette question, je vais vous expliquer mon expérience personnelle. M'occuper de la documentation de PHPBoost a été pour moi un excellent moyen de découvrir ce CMS (je vous assure il y a toujours des subtilités auxquelles on ne fait pas attention du premier coup d'oeil...). Faire la doc oblige de bien tester toutes les fonctions et la voila un rôle très important pour l'avancée de PHPBoost : la détection et l'avertissement des bugs. Enfin quand on connais bien le fonctionnement de PHPBoost, on est plus apte à répondre aux questions des utilisateurs sur le forum.
==> conclusion vous avez une double satisfaction : rendre le cms plus stable, plus simpliste à l'utilisation et créer une source de données sur son fonctionnement afin d'aider les utilisateurs.

Quelles sont les conditions pour entrer dans l'équipe?

Celui qui grince des dents en lisant cette petite phrase aura compris la règle d'or :


Voila vous avez deviné il faut savoir bien écrire le français et s'exprimer le mieux possible afin que la documentation soit la plus claire et lisible possible!!!
L'idéal est de maitriser un peu le fonctionnement du CMS, mais bon cela vient avec le temps. Les balises du bbcode s'apprennent très vite donc ce ne sera pas un soucis.
Pour créer des copies d'écran, si vous ne savez pas faire je vous montrerai.
Enfin on ne vous demandera pas de rédiger un article par jour mais un minimum de présence sur le site de phpboost serait le bienvenue (du genre on ne vient pas pendant un mois et après on ne vous revoit plus). Rentrer dans une équipe impose un minimum d'investissement.

Le projet futur de la documentation

• Reprendre tous les articles actuels de la documentation existante pour l'améliorer.
• remplir la FAQ qui verra bientôt le jour
  

Comment bien rédiger un article?

Rédaction

Il n'a pas de technique miracle, mais pour bien uniformiser la doc je propose :

• utiliser le système de table des matières pour structurer l'article, en plus cela fait un lien en haut de l'article donc c'est bien (ainsi éviter le système titre/sous titres qui est plus adapté au reste du site qui ne contient pas ce système de table des matières
• bien détailler toutes les options du cms, ne pas hésiter à tester à fond toutes les fonctionnalités, c'est ainsi que l'on peut découvrir des bugs et ainsi les corriger pour rendre le cms plus stable) et à bien les détailler sur la doc
• écrire en français, clairement en soignant au maximum son orthographe, donc bien sur relire ses articles, on peut toujours laisser des coquilles donc si un lecteur en voie une il édite pour corriger.
• Mettre le plus possible de liens vers les autres articles du wiki en utilisant la balise [ link] [ /link]
  

Copies écran

L'idéal est de faire des copies d'écran, comme cela on voit directement de quoi on parle. Voila comment bien faire :

• utiliser le thème main
• éviter de mettre des zone vides
• faire des images en 640 de largeur ainsi cela tient sur les config 1024 mini)
  m'envoyer les copies d'écran pour que je les mettes sur le serveur. Y'a tout un répertoire du serveur consacré a la doc
  

Un petit travail pour rentrer dans l'équipe?

Puisque pour entrer dans les autres équipes de PHPBoost il y a un petit test, ce groupe ne fera pas d'exception. Je ne vous demanderai pas un article de 150 pages, juste un petit articles avec des copies d'écran et bien expliqué, sans fautes.

Le mieux est de me contacter pour voir un peu ce que vous pouvez faire.

Merci et bon courage à tous!

Édité par Mipel Le 13/11/2017 à 12h21

J'ai postulé, j'attends ta réponse.

Je veux bien faire de la relecture et corriger les fautes si je peux apporter ma pierre à l'édifice !

Salut Ptithom,

Je voulais justement te proposer mes services pour mettre à jour la doc avec la sortie de la version 3.0.
A mon travail, je suis formatrice en bureautique et je rédige donc des supports de cours et quand je faisais partie de l'équipe de GuppY, j'étais dans l'équipe de documentation et j'ai d'ailleurs rédigé un document sur le système des skins de la version 4.5 pour les débutants.

shadow pas de soucis au contraire

Bonjour,

J'ai peu de temps de disponible mais je veux bien de manière ponctuelle faire ou compléter de la doc.

Bonjour à toi jeune padawan =) non euhh .
Voilà alors je vais essayer de pas faire des fautes 8-). Cela va être dur mais bon alors j'aimerais aussi faire partie de "l'équipe" mais je pourrais commencer qu'après le brevet que je passe le mardi/mercredi (30 juin et 1 juillet).

Alors j'espère que vous serrez d'accords .
PS: J'ai fais des fautes ?

Renaudpro, ne le prends pas mal mais tu n'as clairement pas le niveau pour rédiger des documentations en bon français.

PS : Gsgsd, tu en as oublié plein en fait

Comme quoi !

ne pas faire de fautes était correct

j'aimerais aussi faire partie de "l'équipe" là je ne suis pas certain que le e de parti soit nécessaire. De même que l'utilisation du conditionnel présent (j'aimerais), mais à la limite cela peut passer.

mais je pourrais commencer par contre là clairement c'est le futur qu'il faut utiliser (pourrai) et changer la formulation en "mais je ne pourrai commencer".

Alors j'espère que vous serrez d'accords pas de S à accord et un seul R à serrez



Mais bon, au delà de cet exercice de style, des fautes cela se corrige. Par contre la motivation ne se corrige pas. On l'a ou on l'a pas, et renaudpro semble l'avoir. C'est peut être le plus important non ?

Édité par soupaloignon Le 26/06/2009 à 17h51

Merci de me protéger, j'essaie de faire du mieux que je peux pour corriger le maximum de fautes !

Bien sûr que si, il faut un "e" à partie. Il ne s'agit pas ici du parti politique qui lui ne prends pas de "e" mais de la partie, c'est-à-dire la fraction d'un tout.

Et le conditionnel est également impératif. Il aimerait, il fait ici une demande, ce n'est pas du futur.





Effectivement, c'est bien "je ne pourrai" mais le conditionnel est acceptable, tout dépend ce qu'il veut exprimer, en gros s'il est sûr s'il pourra commencer à ce moment-là ou s'il pense qu'il le pourra.





La motivation ne fait pas tout, et l'orthographe non plus. Tout le monde fait des fautes, c'est sûr mais 6 ou 7 sur une dizaines de lignes, c'est beaucoup trop. De plus, il s'agit ici de rédiger de la documentation technique. Il faut donc très bien connaître l'outil en question et il faut aussi un minimum de pédagogie. Et de la ténacité, car rédiger de la documentation, c'est très fastidieux.

Même si Ptithom et moi-même ne sommes pas très présents, la rédaction de la documentation demande une dose assez conséquente de travail (je ne compare pas la tâche à celle des développeurs, loin de là).
Cependant, il faut savoir maîtriser un minimum la langue. Je ne m'oppose pas à ta candidature, je te demande juste si tu es sûr de connaître assez le français pour rédiger une documentation, lieu où tu devras être concis et clair.
Je pense que Shadow a résumé la situation. Et l'orthographe n'est peut-être pas le plus important mais si tu passes déjà des heures à rédiger et si, en plus, il faut passer corriger tes (quelques) fautes, alors ce sera plus fastidieux et inutiles qu'avantageux.

Bon, je retire alors .