Estilo de redacción
Queremos contenido claro, práctico y fácil de mantener.
Principios
- Claro > elegante
- Explica con ejemplos
- Define términos nuevos al inicio
- Usa subtítulos (
##,###) para dividir - Evita jerga innecesaria
Formato recomendado
- Párrafos cortos
- Listas para pasos
- Bloques de código con lenguaje:
-
Tono
- directo y respetuoso
- sin gatekeeping
- pensado para gente que está aprendiendo
Links
- Evita links rotos (rompen el build)
- Preferir fuentes oficiales
- Si un link es “temporal”, indícalo como tal
Ejemplo de “buena explicación”
- Primero: qué es
- Luego: por qué importa
- Luego: cómo se usa
- Luego: un lab