Handbook / Cómo mejorar este handbook

Cómo mejorar este handbook

Este handbook lo escribimos entre todos. Cómo proponer un cambio, corregir algo desactualizado o sumar lo que falta.

Varias páginas de este handbook dicen lo mismo: “si algo no refleja la realidad, propón el cambio”. Esta página es el cómo. Porque un handbook que solo puede editar una persona deja de ser de todos, y el nuestro es de todos.

Cuándo proponer un cambio

No hace falta permiso ni una razón grande. Vale la pena editar cuando:

• Algo está desactualizado —una regla cambió, un proceso ya no es así, un enlace murió.
• Algo está mal o confunde —lo leíste y entendiste otra cosa de la que queríamos decir.
• Falta algo que sí nos define —viviste una situación que el handbook no cubre, y el próximo que entre se beneficiaría de tenerla escrita.
• Encontraste una forma más clara de decirlo. La claridad es una mejora, no un lujo.

Si dudas de si vale la pena, vale la pena. El costo de proponer es bajo; el de un handbook que miente sobre cómo somos, alto.

Cómo hacerlo

El handbook vive en un repositorio de código (heyaxel/handbook), como cualquier otra parte del producto. Eso significa que los cambios pasan por el mismo flujo que respetamos en todo lo demás: se proponen, se revisan, se publican.

• Si eres developer: abre un Pull Request con tu cambio. El contenido son archivos .mdx en src/pages/handbook/. Se revisa como cualquier PR y, al mergear, se publica solo.
• Si no eres developer: no necesitas tocar código. Escríbele al CTO o a tu mentor con qué página y qué cambiarías —aunque sea un mensaje suelto—, y lo llevamos al handbook por ti. Nadie se queda sin voz por no saber Git.

Qué NO hacer

• No inventes procesos que no existen para que el handbook se vea más armado. Preferimos un “esto todavía lo estamos definiendo” honesto a un proceso de mentira. Es uno de nuestros valores.
• No borres el contexto de por qué algo es así. Si cambias una decisión, di por qué cambió; el que venga después lo va a agradecer.

Este handbook es un ser vivo. Cada vez que alguien lo mejora, el próximo que entre tiene un mapa un poco mejor.