Como usamos o Confluence para desenvolver requisitos de produto

Este artigo descreve nossas abordagens para usar o Confluence como uma ferramenta de requisitos de produto. Não pretendemos ser universais, mas talvez essas abordagens sejam úteis para resolver suas tarefas que não estão necessariamente relacionadas aos processos de desenvolvimento de requisitos (manter a documentação do usuário, descrever os regulamentos internos do departamento, organizar uma base de conhecimento, etc.).

Todas as mudanças nos requisitos para um novo recurso em uma página

Desenvolvemos produtos empresariais complexos que são replicados para centenas de clientes corporativos. Um de nossos produtos possui mais de 100 módulos funcionais e cada módulo possui um documento de requisitos separado. Os recursos de uma nova versão, via de regra, afetam vários (de 3 a 20) módulos funcionais.







Para entender todas as mudanças de requisitos, a equipe do projeto deve ler todos os documentos que afetam a nova funcionalidade e, além disso, descobrir o que exatamente mudou em cada um deles. É longo e inconveniente.



Para resolver o problema, fizemos um documento resumo para cada nova funcionalidade. Ele contém apenas as partes alteradas dos requisitos do módulo funcional. Ao mesmo tempo, se algo mudar no documento original, isso será automaticamente refletido no documento de resumo.







Algo assim na vida real:







agora a equipe do projeto só precisa ler um documento para entender todas as mudanças. O analista, por outro lado, "coleta" o documento uma vez e não se preocupa que as alterações que surjam devam estar amparadas em dois documentos ao mesmo tempo.



Tecnicamente, isso é implementado usando o plug-in Multi Excerpt , que permite inserir partes do mesmo documento em diferentes documentos.





A fim de compreender e compreender imediatamente o status de todos os requisitos para uma nova funcionalidade em um relance, adicionamos uma tabela atualizada automaticamente ao documento de resumo com uma lista de requisitos relacionados, seus status, analista responsável e uma breve descrição das mudanças.







Isso é feito usando as macros padrão "Relatório de propriedades da página" e "Propriedades da página".

Requisitos de rastreamento

Mudanças nos requisitos de um módulo funcional podem exigir mudanças em outros módulos. Se você se esquecer das mudanças relacionadas durante o estágio de desenvolvimento de requisitos, provavelmente isso se tornará conhecido em um estágio posterior (por exemplo, durante o teste) e afetará o cronograma de lançamento. Infelizmente, tivemos tais precedentes.



Para rastrear o impacto dos módulos funcionais uns sobre os outros e não esquecer as mudanças relacionadas nos requisitos, usamos a funcionalidade de tags (tagging). Acontece uma espécie de rastreamento de requisitos, mas com um grande passo: no nível dos módulos funcionais, e não nos requisitos atômicos.







Com mais de cem módulos funcionais e sua interconexão, mesmo uma grande etapa de rastreamento nos permitiu reduzir significativamente o número de casos em que um analista no processo de desenvolvimento de requisitos para uma nova funcionalidade esquece de levar em consideração os requisitos relacionados.



Para fazer isso, usamos a funcionalidade de marcação padrão do Confluence e a macro de resultados de pesquisa.

Requisitos de versão por lançamento

O Confluence emparelhado com o plugin Scroll Versions permite que você crie um ramo separado de requisitos para cada nova versão, enquanto todos os documentos em cada versão têm seu próprio histórico de alterações. A alternância entre as versões de lançamento é feita em alguns cliques. Além disso, você pode comparar os requisitos de versões diferentes e versões diferentes do mesmo documento na mesma versão.







É assim que alternar entre as versões de lançamento se parece na vida real:

Comentando

Usamos o plugin Talk para trabalhar com comentários .







Suas vantagens:

• Você pode ver os comentários e respondê-los no modo de edição de documentos. Isso é muito conveniente quando você precisa fazer alterações nos requisitos com base nos resultados da revisão
• Não há problemas com comentários paralelos (especialmente se você planeja mudar do MS Word + Sharepoint: você não precisa bloquear o documento inteiro), os requisitos podem ser revisados ​​simultaneamente por toda a equipe do projeto
• Se um comentário for deixado em uma página de recurso em um bloco Multi Excerpt, ele aparecerá automaticamente no documento de requisitos original

Além disso, possui recursos interessantes, como destacar comentários em cores diferentes, gerenciar a visibilidade para diferentes usuários e curtidas.



Abandonamos a funcionalidade de comentários padrão no Confluence, porque tinha desvantagens que eram críticas para nós:

• Não pode ser usado em conjunto com o plugin Multi Excerpt
• Os comentários não são visíveis no modo de edição de documentos
• Os comentários desaparecem se você alterar o texto ao qual foram anexados

Criação de gráficos e maquetes

Primeiro, usamos o MS Visio e exportamos os diagramas em formato de bitmap e depois os carregamos no Confluence. Essa abordagem era inconveniente - a relevância dos esquemas tinha que ser mantida em dois lugares, e isso exigia muita ação.



Como se viu, o Confluence tem muitos plug-ins para trabalhar com todos os tipos de objetos gráficos (diagramas, diagramas, maquetes, etc.). Balsamiq Wireframes para Confluence e Diagramas Draw.io para Confluence permitem que você edite objetos gráficos sem sair do Confluence. No momento, esses plug-ins atendem quase completamente às nossas necessidades.

Recursos básicos

Falarei brevemente sobre os recursos básicos que o Confluence oferece (como a maioria dos outros wikis). Para não repetir a documentação, vou me limitar a uma lista do que usamos principalmente:

• Comparação de versões de documentos. Você pode entender rapidamente como a funcionalidade mudou de uma versão para outra.
• P arallelnoe a edição de um único documento e resolução automática de conflitos. Várias pessoas podem revisar um documento ao mesmo tempo sem ter que esperar sua vez enquanto o documento está bloqueado para edição por outro funcionário (como era quando usamos o Sharepoint e os requisitos eram armazenados na forma de arquivos do Word).
• Modelos de documentos. Criamos modelos para todos os principais tipos de documentos (módulo funcional, recurso, atas de reunião)
• Recursos flexíveis de controle de acesso (até o nível da página). Isso é conveniente, por exemplo, para funcionários terceirizados que não podem ter acesso a todos os requisitos de uma vez
• Exportação de documentos em vários formatos. Ajuda muito nos raros casos em que é necessário transferir documentos para fora.
• Integração com JIRA. Você pode inserir automaticamente o status da tarefa, aprovações e outras informações dos tíquetes JIRA.

Migrando do MS Word

Existem algumas coisas não óbvias que você encontra quase imediatamente após mudar do Word para o Confluence.

Numeração de títulos

Para adicionar numeração automática de títulos, você precisa enquadrar o texto com a macro Numeração de títulos.

Hiperlink para a seção

Para se referir a alguma parte do documento ou ao título da seção dentro do documento, você deve primeiro adicionar a macro Âncora (na localização russa é chamada de "Âncora") e, em seguida, adicionar um hiperlink a ela da parte necessária do documento.

Cor de fundo do texto

Você

pode usar a marcação Markdown (Inserir -> Markup, Markdown) para personalizar o design visual do texto, em particular para destacar o fundo do texto com um preenchimento.









Isso não é muito conveniente, mas ainda não encontramos outra maneira de selecionar o texto com preenchimento.

Contras:

• Copiar e colar texto marcado desta forma a partir da área de transferência geralmente leva à perda de marcação.
• Você pode alterar a marcação apenas no modo de edição do código-fonte da página.

Isso é tudo. Faça perguntas nos comentários!



PS O artigo é baseado no relatório "Confluence Life Hacks for Requirements Development" na conferência Analyst Days, a versão em vídeo deste relatório pode ser vista neste link .



Autor do artigo: Ilshat Gabdullin g1r