documentation - example - httpresponseredirect django
Notas de la versión, ¿para qué? (10)
Corrección de errores y características adicionales. Los usuarios los leerán para determinar si deben tomarse la molestia de instalar una actualización incremental, o esperar hasta la próxima versión porque esta no agrega ninguna característica que necesiten ni corrige ningún error en las características que estaban usando.
Yo diría que al menos requieren que un ser humano los lea y se asegure de que cada nota sea útil. Depende de qué tan buenos sean los comentarios sobre las correcciones de errores.
¿Para qué son las notas de la versión y quién las lee? ¿Deberían / podrían automatizarse simplemente escupiendo correcciones de errores para la versión actual, o merecen una cuidadosa edición humana? Entonces, ¿alguien con un enlace a las mejores prácticas (razonamiento detrás) con respecto a las notas de la versión de software?
Esto es, por supuesto, altamente dependiente del tipo de aplicación / servicio / whatnot,
pero he encontrado que leer las notas de la versión de mis herramientas de desarrollo favoritas, etc.
a menudo me hacen tropezar con características agradables, interesantes o incluso asesinas que probablemente me perdería si no lo hiciera, por lo menos, leer las notas ... bueno, tal vez no sea un asesino, pero entiendes ;-)
Como la mayoría de los usuarios avanzados de la computadora (ahora qué tipo de expresión es esa ...)
Nunca me molesto mucho con la documentación ordinaria, así que esto me da
ese pequeño algo extra además de hacer clic, pasar el ratón y preguntar ...
Esto realmente depende de para quién está diseñada su aplicación y los objetivos de su organización. Sin embargo, tiendo a creer que las notas de la versión deben ser una lista concisa de importantes adiciones, mejoras o correcciones clave que se incluyen en la versión en particular.
Algunas veces basta con un simple volcado de la información del sistema de rastreo de errores, otras veces, creo que deben ser refinados.
La clave es que, por lo general, se considera que las Notas de publicación son el listado de cambios tipo "Oye, mira lo que hicimos".
La nota de lanzamiento depende de su organización.
Puedo hablar por mi organización. Utilizamos notas de lanzamiento en formato PDF y cada vez que publicamos un clic o una versión de fondo. Enviamos al gerente de la oficina la nota de la versión. Este es un documento utilizado por el administrador superior del negocio (no solo TI). Este documento es una forma de que ellos sepan qué está pasando. Lo que ha cambiado, las nuevas características que están ahora en producción, los errores corregidos y otras cosas que podrían querer explicar a su usuario.
Este es un documento que puede tener entre 3 y 4 páginas, que describe el trabajo que se ha realizado en esta versión con palabras breves.
Las notas de la versión también son importantes para su organización de prueba (si tiene una), para que sepan qué ha cambiado en la versión y necesita pruebas.
Las notas de la versión también son muy importantes en el entorno de producción .
Ayudan a responder la vieja pregunta:
¿Qué diablos se está ejecutando actualmente en la producción?
O la pregunta más refinada: ¿este error se ha corregido en este lanzamiento?
Las notas de la versión y los README pueden ser muy importantes si su cliente tiene que tomar medidas especiales además de los procedimientos normales para poder actualizarse. También es útil advertir a los clientes / usuarios de cualquier actualización de db que pueda suceder automáticamente como resultado de la instalación de un parche más reciente. La forma en que lo veo, Release Notes y README debe escribirse para la audiencia del administrador del sistema. Así que incluya los tipos de cosas que les gustaría conocer: resúmenes de cambios importantes, cómo instalarlos, errores conocidos, cualquier cosa que su software pueda hacer y que haga que alguien se quite el pelo, etc.
Nuestras notas de publicación son creadas por humanos en lugar de creadas por máquina. La cubierta tres temas principales.
Qué está incluido en las versiones (lista de archivos)
Cómo instalarlo
Qué cambió desde la última versión (especialmente si los cambios aún no están en el manual).
los artículos 1 y 2 no mejoran mucho de una versión a otra, pero necesitan ser revisados. El artículo 3 requiere más trabajo.
Yo habitualmente leo notas de la versión. Tiendo a querer una lista exhaustiva completa de cambios en las características (o tan buena como plausible) a fin de potenciar más mi utilización del nuevo producto.
Quiero ver cuándo se resuelven ciertos errores críticos o problemas críticos de seguridad.
Las notas de la versión son para que los probadores y los usuarios sepan qué hay de nuevo / cambiado. Además, las notas de la versión se pueden utilizar como documentación de respaldo cuando se factura una nueva "versión" de un software para el cliente que se está creando para ellos. v1.31 parece mucho más fácil de relacionar y profundizar.
En lugar de compilar ambas listas manualmente, si puede usar sus notas de lanzamiento para hacer eso por usted, es genial.