¿Hay algún tipo de directrices o mejores prácticas sobre cómo deben escribirse las notas de la versión? Creo que estoy tratando de encontrar el equilibrio adecuado entre hacer el punto sin ser demasiado específico. Además, ¿el desarrollador suele proporcionar un número de notas de lanzamiento mucho mayor para el equipo de control de calidad que el que se envía a la vista del público?¿Cómo se deben escribir las notas de la versión?
notas de la versión públicas deben contener al menos: la liberación
notas de la versión de control de calidad deben contener al menos:
Tenga en cuenta su audiencia y tratar de pensar lo que necesitan.
Una otra cosa que añadir es el soporte nuevo o discontinuada para ciertas plataformas. (Por ejemplo, dejamos de admitir Win3.1 y agregamos Vista 64 bit).
Algunos puntos adicionales: - Publicar en texto sin formato o, como mínimo, html . No los haga difíciles de ver. - Es común agregar notas de la versión en la parte superior de las notas de la versión anterior. - A veces es bueno referirse a errores significativos conocidos que aún no se han abordado. –
Agradable además. Definitivamente iré por texto sin formato. Pero si puede generar las notas de la versión, no hay ninguna razón para no incluir html, pdf, etc. –
Si usted tiene un sistema de gestión de proyectos/de seguimiento de problemas, que sin duda debe utilizar eso para generar sus notas de la versión. Trac y Redmine en particular son muy buenos en esto.
puntos de liberación deben tener algunas propiedades, IMO:
Realmente depende de la audiencia. Para los usuarios técnicos (por ejemplo, los desarrolladores que usan su API) puede ser muy técnico. En el otro extremo, los usuarios finales de alto nivel de una aplicación que haya creado pueden estar interesados únicamente en las nuevas funciones y los cambios importantes.
En el medio hay usuarios no técnicos que también necesitan los detalles, por ejemplo, el departamento de soporte. Para esas personas, puede dar una descripción detallada sin las especificaciones técnicas de bajo nivel, por ejemplo, "Se corrigió un error en el que el registro no se guardaba en la base de datos".
Una de las mejores prácticas con las notas de la versión en mi opinión es la automatización. Si hay ciertas prácticas recomendadas para el envío de mensajes del sistema de control de revisiones (http://drupal.org/node/52287), puede crear notas de la versión mediante un script automatizado (http://cvs.drupal.org/viewvc.py/drupal/contributions/tricks/cvs-release-notes/). Esto crearía notas de lanzamiento realmente agradables: http://drupal.org/node/226165
El principal colaborador de Release Notes sería su equipo de desarrollo. Es una buena práctica permitir que sus desarrolladores y probadores capturen cualquier información relacionada con notas de la versión en relación con sus artículos de trabajo que están vinculados a conjuntos de cambios en TFS.
Luego puede usar el proyecto de código abierto como http://tfschangelog.codeplex.com para generar notas de la versión. Tiene una versión de GUI y una versión de línea de comando que facilita la programación de informes de notas de versión cada noche.
Buena pregunta, pero sin algunos detalles no obtendrá una respuesta útil. Aproximadamente lo que estás liberando, cómo y quién también ayudará. –
posible duplicado de [Notas de la versión, ¿para qué?] (Http://stackoverflow.com/questions/315628/release-notes-what-for) – lindelof