# Documentation

# Vue d’ensemble

Mojaloop a défini plusieurs standards afin de garantir que la documentation à travers l’ensemble du projet reste cohérente et à jour.

  • Toute la documentation pertinente pour les contributeurs est conservée dans le dépôt "documentation".
  • Le dépôt "documentation" est synchronisé avec GitBook et tout le contenu est consultable dans un format facilement lisible à l’adresse : https://www.gitbook.com/mojaloop (opens new window)
  • Toute documentation devrait inclure :
    • Vue d’ensemble : contexte métier pour expliquer la valeur ou la raison d’être de la page de documentation
    • Détails : informations de synthèse appropriées pour soutenir la documentation

#

Standards de documentation (opens new window)

# Guide de style de la documentation

Toute nouvelle documentation devrait être conforme à la documentation et aux styles discutés ici.

# Guide de style du code

# NodeJS

Nous suivons les standard style guidelines (opens new window). Ajoutez npm install standard à votre package.json.

# Java

Pour Java, nous suivons Checkstyle (opens new window). Mesures de qualité du code