Bonnes pratiques

Avant de vous lancer dans la rédaction, nous vous invitons à lire les paragraphes suivants.

Captures d'écran

Il est toujours bienvenu d'avoir des captures d'écran pour faciliter la compréhension. Mais, il faut garder à l'esprit que ces captures devront être modifiées selon les changements de versions et pour chaque langue traduite. Il est donc judicieux d'en mettre, mais de conserver un équilibre sur leur quantité. Par ailleurs, le widget preview (qui permet d'avoir un aperçu sur les composants, par exemple) devrait permet de réduire le nombre de captures d'écran.

Vous avez à votre disposition une instance moogli de présentation à l'adresse demo.moogli.app, à jour, et qui vous permet d'effectuer des captures d'écran explicitant la démarche.

Les identifiants ES sont entrepreneur1/entrepreneur1 et ceux EA sont admin1/admin1


Ecriture inclusive

Nous essayons d'utiliser une écriture inclusive, en utilisant la jonction de termes : celleux ou utilisateurice par exemple.

Il est également préférable d'utiliser des mots épicènes lorsque cela est possible (exemple élève plutôt qu'étudiant.e)

Plus d'info sur l'écriture inclusive : https://eninclusif.fr/

Ton et langage

Nous devrions dans la documentation adopter un style neutre et factuel. Ca ne veut pas dire qu'il faille être trop formel, le ton peut être détendu et parfois spirituel. Il faut juste garder à l'esprit, quand on emploie un style humouristique, que tout le monde n'a pas le même humour et que l'objet de la doc est de s'adresser à tout le monde.

Lisibilité

Essayons de rendre la documentation agréable à lire. En évitant les paragraphes trop longs, les multiples sous-niveaux. On peut inclure quelques éléments graphiques pour aérer la page, comme les encadrés de messages décrits plus bas.

Petites Astuces

Ajouter une image à la procédure

Si on souhaite ajouter des images dans la documentation, il y a 2 manières possibles:

  • Ajouter un fichier dans la procédure avec le bouton "fichier"
  • Ajouter un fichier descriptif global grâce au bouton "Téléverser/URL"


Copyleft

Cette documentation est un remix de la documentation du -Collectif YesWiki-, et est publiée sous la même licence, Creative Commons CCbySA qui permet à qui le souhaite de :

  • Partager: copier, distribuer et communiquer le matériel par tous moyens et sous tous formats
  • Adapter: remixer, transformer et créer à partir du matériel pour toute utilisation, y compris commerciale.
Selon les conditions suivantes :
  • Attribuer: Vous devez créditer l'Œuvre -Collectif YesWiki- , intégrer un lien vers la licence et indiquer si des modifications ont été effectuées à l'Oeuvre.
  • Partager dans les Mêmes Conditions: Dans le cas où vous effectuez un remix, que vous transformez, ou créez à partir du matériel composant l'Oeuvre originale, vous devez diffuser l'Oeuvre modifiée dans les même conditions, c'est à dire avec la même licence avec laquelle l'Oeuvre originale a été diffusée - à savoir la licence CCbySA

Les communs sont l'avenir, merci de les soutenir :)