Guía de estilo Markdown
Propósito
Unificar criterios de escritura, énfasis y enlaces en la documentación técnica.
Enfasis
- Cursivas: conceptos nuevos, términos extranjeros o énfasis leve.
- Negritas: pasos críticos, nombres de archivos, variables y comandos relevantes.
Monoespaciado: rutas, parámetros, fragmentos de código.
Enlaces
- Preferir rutas relativas entre documentos dentro de
/docs.
- Evitar URLs absolutas salvo cuando sea indispensable.
Diagramas
- Usar Mermaid en bloques de código triple backtick con la etiqueta
mermaid.
Tablas
- Úsalas para parámetros, matrices de decisiones y comparativas.