Fornecendo aos usuários informações do histórico de revisões do programa?

8

Uma limitação de um programa que mantenho é que os usuários finais geralmente não sabem quais alterações foram feitas. Para remediar isso, gostaria de mostrar aos meus usuários uma lista simplificada de alterações feitas em seus programas. Existe uma boa metodologia / abordagem a seguir que criaria uma lista fácil de atualizar que poderia ser inserida na interface do usuário?

Por exemplo: Devo armazenar tudo em um arquivo XML que é lido em um formulário? O histórico de alterações deve entrar em um banco de dados?

Nota: O programa é Winforms (C # 4.0).

ATUALIZAR

Com base no excelente feedback, decidi usar o SQLite como meu armazenamento de informações e fornecerei aos usuários uma lista cronológica de alterações em um controle TreeView.

John M
fonte
1
Apenas avise quando você tiver movido o queijo.
JeffO 13/10
Você pode perguntar isso no UX.se
Ilari Kajaste 28/05

Respostas:

13

Os usuários geralmente não se preocupam com as coisas da mesma maneira que você. Embora você possa ser preguiçoso e simplesmente publicar sua lista de erros, é muito melhor se você demorar um pouco e destacar as alterações no idioma do usuário.

Isso significa perder detalhes. Para quem deseja obter todos os detalhes, você pode incluir uma lista completa de problemas abordados - mas, em geral, suas notas de versão devem mostrar apenas, nesta ordem:

  1. Nova funcionalidade importante, no idioma do usuário .
  2. Alterações no fluxo de trabalho, possivelmente com uma justificativa. Por exemplo: "A caixa de diálogo de impressão foi simplificada; agora você pode encontrar opções de layout de página na página de impressão, em vez do local antigo em Opções de documento".
  3. Grandes correções de bugs, no idioma do usuário . Por exemplo: "Falhas são menos frequentes ao abrir arquivos com mais de 2 GB" em vez de "Estouro de buffer fixo no mt_file_read para entradas> 2 GB"
  4. Um resumo de pequenas alterações no fluxo de trabalho e pequenos novos recursos
  5. Em geral, os usuários não se importam com pequenas correções de bugs, basta dizer "e correções de bugs" ou algo parecido. Novamente, você pode fornecer um link para os detalhes completos para os programadores na platéia. ;)

Isso é mais trabalho, e seus usuários realmente apreciarão a atenção aos detalhes.

Alex Feinman
fonte
2
+1 - O idioma do usuário é definitivamente importante. Vou focar nas alterações relevantes ao usuário (não eu refatorando um método / classe / etc) que afetam a maneira como eles usam o programa.
John M
5

Qualquer rastreador de problemas decente gera notas de versão (com base nas histórias fechadas em uma versão). Incorpore isso como um arquivo de texto e mostre-o onde quiser no seu aplicativo.

Sergiu Damian
fonte
1
+1 normalmente existe um campo separado para a nota de versão, para que os problemas na resposta de Alex possam ser evitados
jk.
2

A primeira pergunta que você precisa responder é se seus usuários se importam. Não é necessário implementar nenhuma funcionalidade ou componente da interface do usuário para adicionar algo que os usuários não desejam ou precisam. Isso é apenas mais código que precisa ser testado e validado. Se não houver requisito para que essas informações sejam exibidas no aplicativo, você é apenas um banhista de ouro - um antipadrão conhecido.

Se seus usuários desejam essas informações, você precisa determinar como disponibilizá-las. Isso deve ser orientado pelos usuários, através dos requisitos que eles fornecem. Você parece querer apresentá-lo como uma ferramenta acessível através da interface do usuário. No entanto, existem muitas outras opções que devem ser consideradas e discutidas com seus usuários (ou com o subconjunto de usuários que desejam essas informações). As opções possíveis incluem "alterações desde a última versão" no README ou no manual do usuário, um arquivo de registro de alterações ao lado do README ou no manual do usuário ou uma página da Web no site do produto que descreve as alterações na versão mais recente com a capacidade de visualizar alterações entre versões mais recentes. Dependendo do formato do arquivo usado para as alterações,

Independentemente de como você o entrega, não faça porque deseja, mas porque seus usuários querem. Caso contrário, você está apenas criando um trabalho que não agrega valor ao seu produto.

Thomas Owens
fonte
Eles desejam a funcionalidade ocasionalmente (você fez as alterações solicitadas?) - Também vou me beneficiar com uma lista cronológica de alterações - incrível o que você pode esquecer em 6 meses.
John M
@JohnM Eles disseram que desejam a funcionalidade? Eles disseram que desejam que seja visível dentro do aplicativo? Não faça placa de ouro. Complete apenas os requisitos estabelecidos e atenda-os da maneira mais simples possível.
Thomas Owens
Tornar a lista visível a partir do aplicativo pode ser tão simples quanto adicionar um link clicável ao URL, as informações de alteração no site da empresa em um menu ou sobre o diálogo (como um controle LinkLabel). Se você realmente precisa de acesso offline, sempre pode vincular a um arquivo HTML estático instalado com o aplicativo.
Stephen C. Steel