Documentación en Markdown

Documento global del workspace y documentos por colección.

Documento del workspace

La ruta Documentación del workspace ofrece un Markdown general del proyecto: visión, convenciones, enlaces internos, etc.

Documento por colección

Dentro de cada colección puedes editar Markdown asociado a la API (descripción, guías, ejemplos). El editor suele incluir vista previa y, en equipos, control de versiones o conflictos similares al resto de documentos.

Buenas prácticas

  • Estructura con encabezados claros (##, ###).
  • Enlaza a entornos y a evidencias cuando describas flujos end-to-end.
  • Mantén el contenido alineado con el OpenAPI y las colecciones importadas.