KjerrEjemplos de changelog
que vale la pena copiar.
Los buenos ejemplos de changelog tienen tres cosas en común: un título que dice qué cambió, una frase sobre lo que el usuario ya puede hacer y una nota honesta sobre qué hacer después. Abajo hay cuatro entradas, una por cada tipo de cambio; después, changelog vs. release notes y una lista de comprobación.
Cuatro ejemplos de changelog, por categoría
Cada ejemplo está escrito para un producto ficticio, en las cuatro categorías que usa la sección Novedades de Kjerr. Copia la forma, no las palabras.
Nueva función
Ya está aquí la verificación en dos pasos
Ahora puedes proteger tu cuenta con un segundo paso al iniciar sesión. Abre Ajustes, luego Seguridad, escanea el código QR con cualquier aplicación de autenticación y guarda tus códigos de recuperación. El propietario del espacio de trabajo puede exigirla a todos los miembros. Era una de las ideas más pedidas de nuestro tablero.
Por qué funciona: Empieza por lo que el usuario ya puede hacer, dice dónde encontrarlo y reconoce la solicitud.
Mejora
Los informes cargan hasta tres veces más rápido
Rehicimos la forma de calcular los informes. El resumen mensual, que en las cuentas grandes tardaba seis segundos, ahora se abre en menos de dos, y los intervalos de más de un año ya no se quedan colgados. Las cifras en sí no cambian.
Por qué funciona: Da un número que el lector puede sentir y despeja la duda de si cambiaron los datos.
Corrección
Corregido: la exportación CSV perdía la última fila
A las exportaciones de más de 10.000 filas les faltaba la última. Está corregido, y las exportaciones hechas a partir de hoy están completas. Si exportaste un informe grande en la primera quincena de agosto, vuelve a generarlo.
Por qué funciona: Dice qué fallaba, a quién afectó y qué debe hacer. Sin eufemismos.
Aviso
En qué vamos a trabajar este otoño
Un vistazo rápido a los próximos meses, a partir de lo que votaste. Las notificaciones en Slack ya están en desarrollo. Después viene el modo oscuro: es la idea más votada del tablero y el diseño ya ha empezado. Avisaremos aquí cuando se lance cada una.
Por qué funciona: Fija expectativas sin fechas que no pueda cumplir y remite a los votos.
Anatomía de una entrada de changelog que funciona
- Título: el cambio, no la versión. “Los informes cargan hasta tres veces más rápido” le dice al lector si le interesa. “v4.12.1”, no.
- Categoría. Nueva función, Mejora, Corrección o Aviso. Permite ojear y filtrar.
- Qué puedes hacer ahora. Una o dos frases desde el lado del usuario.
- Dónde encontrarlo. La ruta en el menú, o un enlace.
- Qué hacer después. Muchas veces, nada. Si una corrección exige volver a exportar o cambiar un ajuste, dilo sin rodeos.
- Reconoce la solicitud. Si los usuarios lo pidieron, enlaza la solicitud. Es la prueba más barata de que alguien lee el feedback.
Changelog vs. release notes
Un changelog es el registro continuo de todos los cambios relevantes; las release notes (notas de versión) son la explicación de un lanzamiento concreto. El changelog es una lista que se ojea: entradas cortas, de la más reciente a la más antigua, una por cambio. Las release notes son un documento que se lee: agrupan los cambios de una versión, explican los más grandes con capturas de pantalla e incluyen los pasos de actualización o de migración.
A los equipos pequeños les suele bastar con el changelog, con una entrada más larga cuando el lanzamiento lo merece. Los productos con instalaciones versionadas o con una API suelen publicar también release notes y enlazarlas desde cada entrada del changelog.
Lista de comprobación antes de publicar
Lee la entrada como un usuario que nunca ha visto tu roadmap.
- ¿El título se entiende sin el texto?
- ¿La primera frase habla del usuario y no del equipo?
- ¿Hay un número, una ruta o una captura de pantalla allí donde ayudaría?
- Si algo se rompió, ¿dice a quién afectó y qué hay que hacer?
- ¿Están enlazadas las solicitudes a las que responde?
- ¿Se enterarán quienes lo pidieron, y no solo quienes pasen por allí?
Cómo publicar entradas así en Kjerr
La sección Novedades de Kjerr es un changelog con las cuatro categorías de arriba. Las entradas admiten encabezados, listas, enlaces e imágenes, señalan las ideas a las que responden y, al publicarse, pueden enviar un correo a los suscriptores.
- Categorías, búsqueda por texto y por fecha, reacciones con emoji y comentarios.
- Suscripción por correo con dirección verificada.
- Las ideas enlazadas aparecen bajo la entrada; pasarlas a Shipped envía un correo a sus votantes.
- Un widget para tu propio sitio muestra los mismos anuncios en un panel lateral, con el número de entradas sin leer en el lanzador.
Preguntas con respuestas claras.
¿Qué es un changelog?
Un changelog es una lista con fecha de los cambios de un producto, ordenada de lo más reciente a lo más antiguo y escrita para quienes lo usan. Cada entrada dice qué cambió, a quién afecta y qué hay que hacer, si es que hay que hacer algo.
¿Qué diferencia hay entre un changelog y unas release notes?
Un changelog es el registro continuo de todos los cambios relevantes; las release notes, o notas de versión, son la explicación de un lanzamiento concreto. Una entrada de changelog son unas pocas frases. Unas release notes pueden ocupar una página, con capturas de pantalla y pasos de actualización. Muchos productos publican ambas cosas en el mismo lugar.
¿Qué debe incluir una entrada de changelog?
Un título que diga qué cambió, una categoría, una o dos frases sobre lo que el usuario ya puede hacer, dónde encontrarlo y cualquier acción necesaria. Si el cambio responde a una solicitud, dilo y enlázala.
¿Cada cuánto hay que actualizar un changelog?
Cada vez que se lance algo que los usuarios puedan notar. Una entrada corta cada semana o dos genera más confianza que una larga cada trimestre.
¿Dónde debería estar un changelog?
En una página pública con su propia dirección, para que se pueda enlazar, buscar e indexar, y en el correo de quienes se suscriban. Kjerr lo pone en el mismo tablero que las solicitudes de funciones.
Páginas relacionadas
Dales una respuesta a tus usuarios.
Kjerr es gratis durante el acceso anticipado: todas las funciones, sin tarjeta de crédito. Cuando lleguen los planes de pago, se cobrarán por espacio de trabajo, nunca por licencia de administrador.