Avançar para a área de conteúdo

ir para o conteúdo principal

developerWorks Brasil  >  Rational  >

30 dicas de produtividade dos desenvolvedores do IBM Rational Requirements Composer: Parte 2. Colaboração

Dicas para adicionar comentários e links

developerWorks
Opções de documento

Opções de documento que necessitam de JavaScript não são exibidas


Classificar esta página

Ajude-nos a melhorar este conteúdo


Nível: Introdutório

Lynne P. Kues, Advisory Software Engineer, IBM Corporation
David E. Murray, Staff Software Engineer, IBM

03/Jun/2009

O IBM Rational Requirements Composer estimula a colaboração oferecendo ferramentas e visualizações universais para procurar, comentar, definir e navegar links entre artefatos de qualquer tipo. A exploração desses recursos comuns é pontuada por dicas específicas dos desenvolvedores do Rational Requirements Composer para ajudá-lo a usar este software de forma mais produtiva. Analistas com esses conhecimentos gastarão menos tempo abrindo artefatos desnecessariamente e redigitando informações redundantes e mais tempo aperfeiçoando os requisitos de seus clientes. Esta é a Parte 2 de uma série de três partes.

Na Parte 1, sobre navegação, exploramos as diversas formas que um artefato pode ser localizado e aberto em um editor. Agora chamamos sua atenção para o que pode ser feito com um artefato após sua abertura.

No Rational Requirements Composer, os recursos usados para comentar no artefato ou elementos dentro dele e para conectar a artefatos criados por outros membros do seu time são universais. O editor para todo tipo de artefato, mesmo aqueles artefatos que não são nativos do Rational Requirements Composer (imagens, documentos do Microsoft® Word®, etc), incluem os mesmos controles no cabeçalho e barra lateral para visualizar e gerenciar os comentários, links e requerimentos do artefato. As seções a seguir descrevem como utilizar melhor esses recursos.

Dicas para adicionar comentários

Visualização da barra lateral de comentários

A visualização da barra lateral de comentários mostra todos os comentários para um artefato em especial. Os comentários podem ser criados a partir de qualquer uma das áreas a seguir:

  1. Área de edição de um artefato, utilizando o botão da barra de ferramentas Adicionar ComentárioAdd comment icon (controle esquerdo na Figura 1) ou o menu suspenso para um elemento.
  2. Menu Comentário (botão direito na Figura 1) na visualização da barra lateral de Comentários. O menu Comentários é sensível ao contexto, baseado no que está selecionado na área de edição do artefato.

Figura 1. Criando um comentário
Comments menu view

No menu Comentários se encontram opções para criar um novo comentário para um elemento ativo (rótulo "Mastercard" na captura de tela anterior) e para responder ao comentário selecionado. O menu Comentários pode ser exibido através do uso do item de ferramenta suspensa na barra de ferramentas da barra lateral ou ao clicar com o botão direito do mouse dentro da barra lateral.

Dica 1:
Antes de escrever um comentário que seja específico a um elemento do artefato (por exemplo, um rótulo no esboço da interface de usuário, ou um parágrafo de um documento), clique no elemento para selecioná-lo. Quando os seus colegas de equipe clicarem no comentário mais tarde, aquele elemento será selecionado para eles.

A barra lateral de Comentários também contém uma opção para criar um comentário para o artefato (ao invés de comentar em um elemento dentro do artefato). Os comentários no nível dos artefatos são criados usando a ação Criar um Novo Comentário para o Artefato. Para criar comentários para os recursos que não sejam do Rational Requirements Composer, use os comentários no nível do artefato.

Comentários rich text

A janela Adicionar Comentário (Figura 2) suporta o verificador ortográfico que está ativado por padrão, assim como formatação rich text e criação de links.


Figura 2. Janela Adicionar Comentários
Formatting options highlighted

Dica 2:
Quando apropriado, enriqueça seus comentários com rich text e links para facilitar a navegação para os leitores dos comentários. Aproveite também o recurso de verificação ortográfica.

Você pode navegar para os links dos comentários através da barra lateral de Comentários. O comentário exibido na Figura 3 possui dois links.


Figura 3. Comentário com links
Screen segment that shows links

Filtrar comentários

Conforme os artefatos são definidos, revistos e revisados, o número de comentários sobre o artefato crescerá. É possível usar filtros para limitar quais comentários são exibidos na barra lateral. Por exemplo, você pode estar interessado apenas em comentários de um determinado período de tempo, ou apenas em comentários dirigidos a você. Use o botão Filtro da barra de ferramentas na barra lateral de Comentários para filtrar os comentários.

As seções da barra lateral de comentários indicarão quando os comentários são filtrados. Na captura de tela da Figura 4, três comentários atendem aos critérios especificados e dois comentários são filtrados, como indicado pelo rótulo (3 de 5).


Figura 4. Indicação de filtro na seção da barra lateral de comentários.
'Comments (3 of 5)' highlighted

Dica 3:
Use os controles de filtros na barra lateral de comentários para visualizar apenas os comentários que são importantes para você, como aqueles endereçados a você ou criados na última semana, etc.

Quando os comentários são filtrados, os comentários e todas as respostas serão considerados, e sempre será exibido o comentário que deu origem à resposta. Na Figura 5, O Comentário 1 está sendo exibido, pois estamos filtrando por "Janet Thompson", e Janet respondeu ao comentário original.


Figura 5. Respostas a um comentário não filtrado
Comment 1 shows a reply from Janet Thompson

A ação Destacar Todos considera o filtro. Na Figura 6, apenas aqueles elementos que possuem comentários exibidos na barra lateral de comentários são destacados. Elementos com comentários filtrados não são destacados.


Figura 6. Elemento comentado destacado
Screen capture with Comments sidebar on right

Classificar e agrupar comentários

Os Comentários podem ser classificados e agrupados dentro da Barra Lateral de Comentários. Por exemplo, é possível usar a opção Agrupar por Elemento do Artefato para visualizar os comentários conforme se relacionam com elementos particulares de um diagrama.


Figura 7. Comentários agrupados por elemento
Comments for the <EndEvent1> element only

Também é possível classificar e agrupar por Autor e por Data.

  • Na classificação e agrupamento por Autor, o autor do comentário de nível-superior será usado como base para a operação.
  • Ao classificar e agrupar por Data, o comentário de nível-superior e todas as suas respostas serão considerados; portanto, será refletida a data da última atividade para o comentário (incluindo suas respostas).

Na Figura 8, os comentários estão agrupados por Data da Última Modificação (mais recente primeiro). A "Última Modificação" é o ponto chave aqui. O Comentário 4 foi feito em 9 de dezembro de 2008, então o comentário é mais antigo que o Comentário 10, que foi feito em 6 de janeiro de 2009. Porém, o comentário feito anteriormente (4) aparece antes do mais novo (10), pois o comentário mais antigo tem a resposta mais recente. Portanto, o Comentário 4 acaba aparecendo antes do Comentário 10 na lista.


Figura 8. Comentários e respostas classificados por data
Comments in this order: 4, 10, 7, 6

Dica 4:
Agrupe ou classifique comentários por Data da Última Modificação para destacar linhas de comentários que estão "ativas" (comentários ou respostas que foram feitos recentemente).

Enviar email a partir de um comentário

Cada comentário inclui o nome do usuário que escreveu o comentário e o nome do usuário para o qual o comentário foi direcionado (quando especificado). Clique com o botão esquerdo do mouse no nome do usuário para enviar email para aquele usuário.


Figura 9. Clicar no Nome do Usuário para enviar e-mail.
'Send Email to User' shows after clicking on name

Resolver múltiplos comentários

A barra lateral de comentários suporta seleções múltiplas. Para selecionar múltiplos comentários, use a tecla Ctrl ao selecionar um comentário. A ação Resolver Comentário no menu contexto está disponível quando um ou mais comentários são selecionados, para que múltiplos comentários possam ser resolvidos em uma única operação.

Para resolver todos os comentários para um elemento, selecione o elemento dentro da área de edição de artefato. Essa ação selecionará os comentários associados ao elemento na barra lateral. Na captura de tela abaixo, três comentários estão associados à tarefa Validar Cartão de Crédito. Esses comentários são selecionados na barra lateral quando o elemento é selecionado. A ação Resolver Comentário poderá ser executada para resolver todos os comentários do elemento.


Figura 10. Selecionar múltiplos comentários
Show selecting multiple comments

Dica 5:
Use Ctrl para selecionar múltiplos comentários e resolvê-los de uma única vez. Para resolver todos os comentários para um elemento, selecione o elemento e, consequentemente, resolva os comentários destacados.



Voltar para parte superior


Dicas para adicionar links

Visualização da barra lateral de links

A visualização da barra lateral de links exibe todos os links para e de um artefato em particular. Dentro da visualização, os links são exibidos no seguinte formato:

Artefato Alvo (do Elemento de origem)

em que o Artefato Alvo é o artefato para o qual você está criando o link (destino) e o Elemento de Origem é o elemento a partir do qual você está criando o link (origem).

Os links podem ser criados a partir da área de edição de um artefato, usando o menu de contexto do elemento ou usando o botão (Show linking button) da barra de ferramenta Link para outros artefatos para um elemento que está em um artefato baseado em diagrama.

Os links também podem ser criados a partir da visualização da barra lateral de links (Figura 11). O menu Links na barra lateral de links é sensível ao contexto, baseado no que está selecionado na área de edição do artefato.


Figura 11. Crie um link para um elemento ou artefato
Links sidebar screen capture

A barra lateral de Links também contém uma opção para criar um link para o artefato (um link em que o artefato é a origem do link, não um elemento dentro do artefato). É possível criar links no nível dos artefatos usando a ação Criar um Novo Link para o Artefato. Os links no nível do artefato são particularmente úteis para definir links para recursos que não são nativos ao Composer.

Filtrar Links

Dentro da visualização da barra lateral de links, é possível filtrar os links de acordo com o tipo de artefato alvo do link. Use o botão Filtro da barra de ferramentas (As três setas apontando para a direita na Figura 12) na barra lateral de links para filtrar os links.


Figura 12. Filtrar os links exibidos na barra lateral de links
Filter button icon

Dica 6:
Filtrar os links na barra lateral de links para encontrar rapidamente referências aos artefatos de um tipo em particular (por exemplo, um documento do Microsoft Word).

As seções da barra lateral de links indicarão quando os links são filtrados. Na Figura 13, quatro links de saída são descartados e são exibidos 5 de 9.


Figura 13. Links de saída exibidos com alguns links filtrados.
9 outgoing links total but only 5 listed

A ação Destacar Todos considera o filtro. Na Figura 14, apenas aqueles elementos que possuem links exibidos na barra lateral de links são destacados. Elementos com links descartados não são destacados.


Figura 14. Apenas elementos com links que não foram descartados são destacados
Icon shows a highlighter pointing to a page

Modificar Links

Dentro do Rational Requirements Composer, cada artefato é identificado por uma cadeia de caracteres permalink que é um identificador único que não é derivado do nome ou localização do artefato. Portanto, se um artefato é renomeado ou movido para uma pasta diferente, os links que apontam para o artefato são preservados.

Dica 7:
Não se preocupe com links para um artefato quando renomear o artefato ou movê-lo para outra pasta. Os links existentes para ele não serão afetados.

É possível modificar links existentes usando a opção Editar através da visualização pop-up de Links (Figura 15). É possível abrir essa visualização usando o botão Link para outros artefatos na barra de ferramentas do elemento, ou no menu suspenso do elemento.


Figura 15. Indicação de que um elemento possui um link quando for selecionado
'Edit' icon shows pencil and paper

Para editar um link existente, selecione o link na visualização e use o menu suspenso de visualização. A ação Editar Link abrirá a Janela de diálogo "Link para", em que a descrição, tipo e o alvo do link podem ser modificados.


Figura 16. Modificar um link existente
'Edit Link' selected in drop-down menu

Os links no nível do artefato podem ser modificados através da barra lateral de links. Use o item do menu Gerenciar Links de Artefatos (Figura 17) do botão Links na barra de ferramentas da barra lateral. Isso abrirá a visualização Pop-up de Links que lista todos os links no nível do artefato. Observe que essa visualização pop-up lista apenas os links no nível de artefato, não todos os links para o artefato. Os links originados de elementos dentro do artefato possuem sua própria visualização pop-up de links que pode ser aberta através do menu de contexto do elemento ou do botão Link para outros artefatos na barra de ferramentas do elemento.


Figura 17. Modificar ou excluir links para artefato de nível superior
'Manage Artifact Links' selecte

Arraste itens para criar links

Você pode arrastar e soltar recursos nos seguintes artefatos para criar links:

  • Actor
  • Business Process Diagram
  • Document
  • Requirement
  • Use Case
  • Use Case Diagram

Use o Explorador de Projetos ou a visualização de procura para arrastar artefatos para criar links. Em editores baseados em diagramas, um fundo cinza claro indicará para qual elemento o link será criado (veja Figura 18).


Figura 18. Arraste o artefato para um elemento do diagrama para criar um link.
'Shop for CD' element highlighted by gray

Você também pode criar links no nível do artefato para um diagrama soltando o artefato alvo no espaço vazio do diagrama.

Dica 8:
Ao decorar um artefato com links para vários outros artefatos, considere trazer os outros artefatos para o Explorador de Projetos ou para a Visualização de procura e adicionar os links através da ação de arrastar. Porém, se os links forem criados no editor, será necessário navegar até cada artefato alvo na caixa de diálogo "Link para". Arrastar artefatos economizará tempo, pois não há necessidade de fazer essa navegação para cada link.

Para editores baseados em documentos (actor, document, requirement, use case), uma linha vertical vermelha indicará onde o link será criado no documento. Para editores com base em documentos, os artefatos também podem ser integrados no documento apertando e segurando a tecla Ctrl quando soltar o artefato no alvo.


Figura 19. Integrar um artefato arrastando para um documento enquanto segurando a tecla Ctrl
Red vertical line

Criação de links e requerimentos

Associar requerimentos com artefatos e elementos dentro de um artefato é uma operação separada e diferente da criação de links. Na criação de links, o painel Escolha Artefato Existente na caixa de diálogo "Link" filtrará os artefatos de requerimento, e o painel Criar Novo Artefato não incluirá os tipos de requerimento. Para associar um requerimento a um elemento dentro de um artefato, use a ação Marque como Requerimento (Figura 20). Esta ação está no menu de contexto para elementos de artefatos.


Figura 20. Extrair um requerimento de um elemento de diagrama
'Mark As Requirement' context menu

Também é possível associar requerimentos a um elemento usando o ícone Mostrar Requerimentos na barra de ferramentas do elemento (Figura 21).


Figura 21. Gerenciar os links para um elemento através do controle na barra de ferramentas
Icon: Yellow circle in square brackets

Requerimentos de são relacionados a um artefato aparecem em uma barra lateral separada. A barra lateral de requerimentos opera como a barra lateral dos Links. É possível escolher entre as ações Destacar Todos, Filtrar, ou Classificar, e a navegação para elementos fonte ou alvo fica disponível. Observe que a barra lateral de Requerimentos (Figura 22) não inclui as seções de Entrada e Saída como na barra lateral dos Links. Quando um requerimento é associado com um artefato, o artefato aparecerá como um Link de entrada na barra lateral de links para o requerimento.


Figura 22. A barra lateral de Requerimentos
List of linked requirements

Para associar os requerimentos com o artefato como um todo, use a ação Criar um Novo Requerimento para o Artefato através do menu de Requerimentos na barra lateral de Requerimentos.


Figura 23. Extrair um requerimento de um artefato inteiro.
Option selected on menu

Você pode gerenciar e editar um requerimento no nível do artefato usando a ação Gerenciar Requerimentos do Artefato através do menu de Requerimentos na barra lateral. Isso abrirá a visualização de Requerimentos que lista todos os requerimentos no nível do artefato.


Figura 24. Modificar ou Apagar requerimentos para artefato de nível superior
Requirements menu

Observe que essa visualização pop-up lista apenas os requerimentos no nível de artefato, não todos os requerimentos para o artefato. Os Requerimentos originados de elementos dentro do artefato têm sua própria visualização pop-up que pode ser aberta através do menu de contexto do elemento ou o ícone Mostrar Requerimentos na barra de ferramentas do elemento.

Links de marcadores

Um link marcador é um link com um alvo inicial não definido. Suponha que vai encontrar um novo usuário para discutir os requerimentos para um aplicativo específico. Durante a reunião, você começa a discutir alguns dos projetos de interface do usuário, e decide criar um Esboço de Interface de Usuário para capturar o que está sendo discutido. Conforme define os elementos do esboço com o usuário, torna-se aparente que um artefato de Documento é necessário para definir as regras de validação para um campo em particular. Ao invés de ter que criar explicitamente um novo artefato de Documento para essa informação adicional, você pode criar um link de marcador para o campo e continuar com o trabalho em mãos (projetar a interface do usuário). É possível capturar as regras de validação mais tarde.

Dica 9:
Use links marcadores para capturar relacionamentos com artefatos que ainda não existem como uma forma de criar protótipos de requerimentos rapidamente.

Para criar um link marcador, use a visualização de pop-up de links e especifique uma descrição de link, mas não especifique um alvo para o link. Na Figura 25, um link para regras de manuseio e correio está sendo criado, mas o artefato que define tais regras ainda não existe, então apenas uma descrição de link é especificada.


Figura 25. Adicione um link sem definir um alvo
Links pop-up view

Na barra lateral de Links, links marcadores são identificados com um ícone em forma de diamante. Para especificar um alvo para um link marcador, é possível clicar no link na barra lateral de Links, ou editar o link na visualização pop-up de Links. Ambas as ações abrirão a Janela "Link para", onde é possível especificar o alvo para o link.


Figura 26. Um link marcador
Showing a placeholder link

Também é possível usar marcadores quando associar requerimentos a um artefato. Na Figura 27, o campo nome do Portador do Cartão tem um requerimento de marcador para Validação do Portador do Cartão.


Figura 27. Um requerimento de marcador
Requirements window

Links especiais

Várias operações criam relacionamentos entre artefatos, e o Rational Requirements Composer captura automaticamente esses relacionamentos criando um link na barra lateral de Links ou Requerimentos. As operações que criam links são listadas por tipo de artefato:

  1. Diagrama de Processos de Negócios
    1. Elaborando uma tarefa com um diagrama ou esboço de Caso de Uso
    2. Associando um caso de uso de Sistema com uma tarefa
    3. Associando um processo com um subprocesso
  2. Diagrama de Caso de Uso
    1. Usando um ator compartilhado ou caso de uso compartilhado
    2. Elaborando um uso de caso com esboço sequencial
  3. Glossário
    1. Especificando um termo relacionado ou sinônimo
  4. Requerimento
    1. Gerenciando um Requerimento na IBM® Rational® RequisitePro®
  5. Esborço de Interface de usuário
    1. Reusando uma imagem, parte ou esboço
  6. Parte de Interface de usuário
    1. Reusando uma imagem, parte ou esboço
  7. Esboço sequencial
    1. Associando um esboço a um quadro
  8. Artefatos com base em texto (document, actor, use case, requirement)
    1. Inserindo uma imagem ou artefato (se o artefato inserido é um requerimento, essa associação será adicionada a barra lateral de Requerimentos)
    2. Integrando um Requerimento usando Marcar como Requerimento (Esta associação será adicionada a barra lateral de Requerimentos)
    3. Criar Link para um termo

Observe que estes links não podem ser diretamente editados ou apagados. O Rational Requirements Composer gerencia esses links como informação sobre as mudanças de relacionamento, ou o relacionamento é removido.

Diga 10:
Ao ler ou revisar um artefato escrito por um colega, veja os links de entrada e saída e requerimentos para ver se existem artefatos relacionados que sejam do seu interesse.



Voltar para parte superior


Resumo das Dicas

Dica 1:Antes de escrever um comentário que seja específico a um elemento do artefato (por exemplo, um rótulo no esboço da interface de usuário, ou em parágrafo de um documento), clique naquele elemento para selecioná-lo. Quando os seus colegas de equipe clicarem no comentário mais tarde, aquele elemento será selecionado para eles.

Dica 2:Quando apropriado, enriqueça seus comentários com rich text e links para tornar a navegação mais fácil aos leitores dos comentários. Aproveite também o recurso de verificação ortográfica.

Dica 3:Use os controles de filtros na barra lateral de Comentários para visualizar apenas os comentários que são importantes para você, tais como aqueles endereçados a você ou criados na última semana, etc.

Dica 4:Agrupe ou classifique comentários por Data da Última Modificação para destacar linhas de comentários que estão "ativos" (comentários ou respostas que foram feitos recentemente).

Dica 5:Use Ctrl para selecionar múltiplos comentários e resolvê-los todos de uma vez. Para resolver todos os comentários para um elemento, selecione o elemento e, consequentemente, resolva os comentários destacados.

Dica 6:Filtrar os links na barra lateral de Links para encontrar rapidamente referências aos artefatos de um tipo em particular (por exemplo, um documento do Microsoft Word).

Dica 7:Não se preocupe com links para um artefato quando renomear o artefato ou move-lo para outra pasta. Os links existentes para ele não serão afetados.

Dica 8:Ao decorar um artefato com links para vários outros artefatos, considere trazer os outros artefatos para o Explorador de Projetos ou para a Visualização de procura e adicionar os links através da ação de arrastar. Se os links são criados no editor, haverá necessidade de navegar para cada artefato alvo na caixa de diálogo "Link para". Arrastar artefatos economizará tempo, pois não há necessidade de fazer essa navegação para cada link.

Dica 9: Use links marcadores para capturar relacionamentos com artefatos que ainda não existem como uma forma de criar protótipos de requerimentos rapidamente.

Dica 10: Ao ler ou revisar um artefato escrito por um colega, veja os links de entrada e saída e requerimentos para ver se existem artefatos relacionados que sejam do seu interesse.



Recursos

Aprender

Obter produtos e tecnologias

Discutir


Sobre os autores

Lynne Kues photo

Lynne Kues, an advisory software developer with the IBM Rational Product Development group, is working on the Web client for Rational Requirements Composer. Before joining Rational group, Lynne spent most of her time developing IDEs and GUI toolkits. She was a developer on the Eclipse UI, SWT, eSWT, and VisualAge for Java teams. She lives in Asheville, North Carolina, in the U.S.


Author1 photo

David Murray is a member of the Common User Interface team for IBM Rational Requirements Composer. He was primarily responsible for the project home page and Search view in the rich client. David graduated from the Rochester Institute of Technology in 2004 with a bachelor's degree in computer science. Before joining the Rational Requirements Composer team, he worked on the editor for the Enterprise Generation Language (EGL) component of IBM Rational Business Developer, where he gained experience in delivering streamlined software for less-technical business developers.




Avalie esta página


Reserve um instante para completar este formulário para nos ajudar a servi-lo melhor.



 


 


Não
são úteis
Extremamente
úteis
 





IBM, Rational e o logotipo da IBM são marcas registradas da International Business Machines Corporation nos Estados Unidos e/ou em outros países. Java e todas as marcas registradas e logotipos baseados em Java são marcas registradas da Sun Microsystems, Inc. nos Estados Unidos e/ou em outros países. Outros nomes de empresas, produtos e serviços podem ser marcas registradas ou marcas de serviço de terceiros.