# Documentación

# Descripción general

Mojaloop ha establecido varios estándares para garantizar que la documentación de todo el proyecto sea coherente y se mantenga actualizada.

• Toda la documentación relevante para los contribuyentes se conserva en el repositorio "documentation".
• El repositorio "documentation" se sincroniza con GitBook y todo el contenido se consume en un formato fácil de leer en: https://www.gitbook.com/mojaloop (opens new window)
• Toda la documentación debería incluir:
  • Descripción general: descripción general del negocio que aporte el valor o la razón de ser de la página de documentación
  • Detalles: información resumida adecuada para respaldar la documentación

#

Estándares de documentación (opens new window)

# Guía de estilo de la documentación

Toda la documentación nueva debería ajustarse a la documentación y los estilos que se describen aquí.

# Idioma de la documentación

Toda la documentación nueva debería redactarse en inglés y luego puede traducirse a otros idiomas; actualmente también está disponible en francés. Se está trabajando en la traducción de la documentación al español y al portugués.

El equipo de localización ha elaborado directrices para los traductores, que se aplican a todos los pares de idiomas. Estas directrices de traducción están disponibles aquí, en inglés.

# Guía de estilo de código

# NodeJS

Seguimos las directrices de estilo de Standard (opens new window). Agregue npm install standard a su package.json.

# Java

Para Java seguimos Checkstyle (opens new window).Code Quality Metrics