Notas de lançamento - Release notes
Notas de versão são documentos distribuídos com produtos de software ou produtos de hardware, às vezes quando o produto ainda está em estado de desenvolvimento ou teste (por exemplo, uma versão beta ). Para produtos que já estão em uso por clientes, a nota de versão é entregue ao cliente quando uma atualização é lançada. Outra abreviatura para notas de versão é Changelog ou lançamento registos ou alterações de software ou Histórico de edições de arquivo Atualizações ou README . No entanto, em alguns casos, as notas de lançamento e o registro de mudanças são publicados separadamente. Essa divisão é para clareza e diferenciação de destaques de recursos de bugs, solicitações de mudança ( CRs ) ou melhorias do outro lado.
Propósito
Notas de versão são documentos compartilhados com usuários finais, clientes e clientes de uma organização. A definição dos termos 'Usuários finais', 'Clientes' e 'Clientes' são de natureza muito relativa e podem ter várias interpretações com base no contexto específico. Por exemplo, o grupo de Garantia de Qualidade em uma organização de desenvolvimento de software pode ser interpretado como um cliente interno.
Contente
As notas de versão detalham as correções, alterações ou melhorias ( funcionais ou não funcionais ) feitas no serviço ou produto que a empresa fornece.
Eles também podem ser fornecidos como um artefato que acompanha as entregas de Teste do Sistema e Testing System Integration e outros ambientes gerenciados especialmente com referência a uma tecnologia da informação organização.
As notas de versão também podem conter resultados de teste e informações sobre o procedimento de teste . Esse tipo de informação dá aos leitores da nota de lançamento mais confiança na correção / alteração feita; essas informações também permitem que o implementador da mudança conduza testes de aceitação rudimentares .
Eles diferem do contrato de licença do usuário final , pois não contêm (não devem) conter quaisquer termos legais do produto ou serviço de software. O foco deve ser na versão do software em si, não, por exemplo, nas condições legais.
As notas de versão também podem ser interpretadas como descrevendo como instalar ou construir o software, em vez de destacar novos recursos ou bugs resolvidos. Outro termo freqüentemente usado neste contexto é Requisitos do Sistema , significando o hardware e software necessários para instalar ou construir o software.
Estilo de formato
Não existe um formato padrão para notas de versão que é seguido por diferentes organizações. As organizações normalmente adotam seus próprios estilos de formatação com base no requisito e tipo de informação a ser distribuída. O conteúdo das notas de lançamento também varia de acordo com o tipo de lançamento. Para produtos que estão em fase de teste e que foram lançados recentemente, o conteúdo é geralmente mais descritivo em comparação com as notas de versão para correções de bugs e aprimoramentos de recursos, que geralmente são breves.
As notas de lançamento podem incluir as seguintes seções:
- Cabeçalho - Nome do documento (ou seja, notas de versão), nome do produto, número de versão, data de lançamento, data da nota, versão da nota, etc.
- Visão geral - uma breve visão geral do produto e alterações, na ausência de outra documentação formal.
- Objetivo - Uma breve visão geral do objetivo da nota de lançamento com uma lista do que há de novo neste lançamento, incluindo correções de bugs e novos recursos.
- Resumo do problema - uma breve descrição do bug ou aprimoramento na versão.
- Etapas para reproduzir - as etapas seguidas quando o bug foi encontrado.
- Resolução - Uma breve descrição da modificação / aprimoramento que foi feito para corrigir o bug.
- Impacto no usuário final - Quais ações diferentes são necessárias para os usuários finais do aplicativo. Isso deve incluir se outra funcionalidade é afetada por essas mudanças.
- Impactos de suporte - mudanças necessárias no processo diário de administração do software.
- Observações - Observações sobre a instalação de software ou hardware , atualizações e documentação do produto (incluindo atualizações de documentação)
- Isenção de responsabilidade - Mensagens relacionadas à empresa e ao produto padrão. por exemplo; freeware , antipirataria , duplicação, etc. Veja também Disclaimer .
- Contato - informações de contato do suporte.
Uma nota de versão é geralmente um resumo conciso das mudanças recentes, melhorias e correções de bugs em uma versão de software específica. Não é um substituto para os guias do usuário . As notas de versão são freqüentemente escritas no tempo presente e fornecem informações claras, corretas e completas.
Existe uma proposta para uma especificação aberta e é chamada de especificação de esquema de notas de versão.
Exemplos proeminentes (principalmente software)
A lista a seguir é uma seleção dos principais softwares de diferentes ramos, como jogos de software, sistemas operacionais, automotivo, design CAD , etc.
- Notas de versão do projeto Apache Maven
- Atualizações do Apple iOS 14
- Notas de versão do Apple macOS
- Notas de lançamento do Apple Xcode
- Versões do FreeBSD
- Hitfilm Express da FXhome
- Notas de lançamento do GNOME
- Versões do Gitlab
- i.MX Linux ® Release Notes (PDF por NXP Semiconductors )
- Notas de versão do Atlassian Jira Software
- Linux (Ubuntu)
- Linux Kernel 5.x
- Notas de versão do Microsoft Visual Studio
- Minecraft Release Changelogs
- Tesla Software Updates
- Unity3d 2020.1.0
- Software Wikipedia MediaWiki
- Windows 10 (consulte também Windows Release Health )
- Notas de lançamento do Xilinx (por exemplo, Vivado Design Suite )
Veja também
- Changelog
- Gerenciamento de configurações
- Contrato de licença de usuário final
- Leia-me
- Gerenciamento de liberação
- Candidato a Lançamento
- Ciclo de vida de lançamento de software
- SWEBOK
- Termos de serviço
Leitura adicional
- Laura Moreno et al. ARENA: Uma abordagem para a geração automatizada de notas de versão , transações IEEE em engenharia de software (Volume: 43, Edição: 2, 1 de fevereiro de 2017)
- Casey Newton. Bebi cerveja e escrevi notas de lançamento com a equipe de notas de lançamento do Medium, The Verge (10/02/2016)
- Padrões de codificação GNU - 6.8 Logs de alterações
Referências
- ^ "Alterar conceitos de log (padrões de codificação GNU)" . www.gnu.org . Página visitada em 2021-04-05 .
- ^ Scott, James (2020-04-24). "A arte de escrever ótimas notas de lançamento" . Médio . Página visitada em 2021-04-05 .
- ^ "Releases (GNU Coding Standards)" . www.gnu.org . Página visitada em 2021-04-05 .
- ^ "Histórico de versões - Inglês - Base de conhecimento" . kb.i-doit.com . Recuperado em 2021-10-10 .
- ^ "56508 - Zynq-7000 SoC, 14.6 FSBL - Existe um changelog?" . Xilinx Support Keyword Search .
- ^ Hobbs, Brian; Besner, Claude (01/05/2016). "Projetos com clientes internos vs. externos: Uma investigação empírica da variação na prática" . International Journal of Project Management . 34 (4): 675–687. doi : 10.1016 / j.ijproman.2016.02.010 . ISSN 0263-7863 .
- ^ "Alterar Logs (GNU Coding Standards)" . www.gnu.org . Página visitada em 2021-04-05 .
- ^ Wang, C .; Li, J .; Liang, P .; Daneva, M .; Sinderen, M. (setembro de 2019). "Olhos dos desenvolvedores nas mudanças de aplicativos: um estudo exploratório sobre registros de mudanças em aplicativos" . 2019 IEEE 27º Workshops da Conferência Internacional de Engenharia de Requisitos (REW) : 207–212. doi : 10.1109 / REW.2019.00042 . ISBN 978-1-7281-5165-6. S2CID 209460408 .
- ^ Bourne, Kelly C. (2014-01-01), Bourne, Kelly C. (ed.), "Capítulo 10 - Updates and Patches" , Application Administrators Handbook , Boston: Morgan Kaufmann, pp. 150–165, doi : 10.1016 / b978-0-12-398545-3.00010-8 , ISBN 978-0-12-398545-3, recuperado em 2021-03-25
- ^ release-notes / release-notes-spec , Release Notes, 2021-03-25 , recuperado 2021-03-25
- ^ "Kernel Linux versão 5.x - A documentação do Kernel Linux" . www.kernel.org . Recuperado em 2021-03-25 .
- ^ release-notes / release-notes-spec , Release Notes, 2021-03-25 , recuperado 2021-03-25
- ^ "Releases · GitLab.org / GitLab" . GitLab . Recuperado em 2021-02-13 .
- ^ Moreno, L .; Bavota, G .; Penta, MD; Oliveto, R .; Marcus, A .; Canfora, G. (fevereiro de 2017). "ARENA: uma abordagem para a geração automatizada de notas de versão" . IEEE Transactions on Software Engineering . 43 (2): 106–127. doi : 10.1109 / TSE.2016.2591536 . ISSN 1939-3520 .
- ^ Newton, Casey (2016-02-10). “Eu bebi cerveja e escrevi notas de lançamento com a equipe de notas de lançamento do Medium” . The Verge . Página visitada em 2021-04-05 .
links externos
- Como escrever notas de lançamento
- Como as notas de lançamento devem ser escritas? (Stackoverflow)
- A estranha arte de escrever notas de versão de aplicativos
- Release Notes Hub (também https://www.release-notes.com ) de código aberto no GitHub
- Especificação do esquema das notas de versão