Controle e revisões
Solicitações de mudança
Proponha mudanças em itens aprovados ou em linha de base como uma solicitação de mudança, faça-as revisar e aprovar e depois aplique-as em uma única etapa com um registro completo.
Nesta página
Uma solicitação de mudança propõe um conjunto de edições no modelo, explica o motivo e aguarda aprovação antes que algo mude. Use solicitações de mudança para o controle de configuração: depois que os requisitos são aprovados ou uma linha de base é definida, as mudanças passam por uma solicitação que os aprovadores do projeto revisam. As solicitações de mudança ficam em Controle e revisões → Solicitações de mudança.
Como usá-lo
Criar uma solicitação de mudança
- Abra Controle e revisões → Solicitações de mudança e clique em + Nova solicitação de mudança no cabeçalho da página, ou clique em Propor mudança… no cabeçalho da página da Visão do item de um item sob controle de configuração (isso abre a solicitação de mudança em aberto do item, quando houver uma).
- Dê a ela um Título e um Motivo: por que a mudança é necessária e o que ela deve alcançar.
- Clique em Criar e depois adicione os Itens afetados com Adicionar item…. O Holarch lista os itens rastreados até eles (requisitos, testes, interfaces e outros itens relacionados); clique em + nos que também mudam.
Preparar as alterações
- Clique em Adicionar alteração ▾ e escolha o que propor: Alterar um item… (número, nome, descrição no editor de rich text, de modo que a formatação seja mantida, ou um atributo), Novo item…, Excluir um item…, Adicionar um relacionamento…, Remover um relacionamento…, Adicionar um vínculo com outro projeto… ou Remover um vínculo com outro projeto…. Em um projeto SysML v2, Editar texto SysML… propõe uma edição no texto de um package.
- Clique em Preparar alteração. Cada alteração preparada é listada em Alterações propostas, com uma comparação palavra por palavra para alterações de descrição e de texto e a lista de Impacto dela (veja Impacto). Nada muda no modelo ainda.
- Remova uma alteração preparada com Remover.
Enviar, revisar e aprovar
- Clique em Enviar para revisão. No serviço hospedado, os aprovadores recebem um aviso e uma entrada em Meu trabalho → A decidir, onde Aprovar… e Rejeitar… abrem a solicitação com a caixa de diálogo de voto.
- Um aprovador abre a solicitação, checa as alterações propostas e as listas de Impacto delas e clica em Aprovar… ou Rejeitar… (uma rejeição precisa de um motivo). Quando um requisito alterado está em uma linha de base, a caixa de diálogo Aprovar… também lista os itens de verificação e os documentos que precisam de nova revisão.
- O cartão de revisão mostra Aprovações: N de M. Uma solicitação cujas mudanças de estado têm aprovadores próprios também lista cada regra com a contagem dela, por exemplo ○ Todos os aprovadores nomeados (3): 1 de 3. Quando a solicitação tem as aprovações de que precisa, o status dela passa a Aprovada. Uma rejeição a rejeita; o autor pode então editar as alterações e enviá-la novamente.
Retirar encerra uma solicitação ainda não aplicada sem alterar o modelo; o registro dela permanece no log.
Aplicar as alterações
- Um editor ou proprietário abre a solicitação aprovada e clica em Aplicar alterações e depois confirma com Aplicar alterações.
- Todas as alterações preparadas são aplicadas juntas, e um único Desfazer reverte tudo. O histórico de cada item alterado registra a alteração "via CR-12".
- As alterações cujos itens foram excluídos nesse meio-tempo são puladas e listadas com o resultado. Uma liberação de configuração preparada (Adicionar alteração ▾ → Liberar uma configuração…) é registrada com os aprovadores da solicitação, ou listada com o motivo pelo qual não foi liberada; veja Liberar por meio de uma solicitação de mudança.
- A solicitação guarda a lista de Impacto de cada alteração tal como estava logo antes de as alterações serem aplicadas, como registro do que foi considerado. O Histórico dela mostra "impacto registrado" com as contagens, por exemplo "4 afetados, 9 a checar". A aplicação nunca espera pela lista de impacto: se itens em outros projetos ainda estiverem sendo lidos após alguns segundos, a solicitação é aplicada imediatamente e guarda a lista tal como calculada até então, marcada como "Impacto não concluído na aplicação" na solicitação, no Histórico dela e nas exportações.
Trabalhar em uma solicitação de mudança
Em vez de preparar cada alteração em uma caixa de diálogo, você pode trabalhar em uma solicitação de mudança em rascunho: edite o modelo como de costume em qualquer página, e suas edições vão para a solicitação em vez do modelo em uso. O modelo em uso só muda quando a solicitação é aprovada e aplicada.
Ativar
Trabalhar em solicitações de mudança fica desativado em todos os projetos até que um proprietário do projeto o ative: abra Ajustes na página Solicitações de mudança e marque Trabalhar em solicitações de mudança: editar em um rascunho e aplicar após a aprovação. Desativá-lo é recusado enquanto um rascunho ainda contém edições feitas nele; aplique ou retire essas solicitações primeiro. No serviço hospedado, trabalhar em solicitações de mudança vem com o plano Team do proprietário do projeto, assim como as regras de aprovação (veja a nota em Controle de configuração): um endereço de e-mail acadêmico verificado ou a participação em uma organização de turma ativa também o incluem, e os projetos que usavam as regras de aprovação antes da versão 2.29.0 o mantêm. Nos outros planos, o ajuste aparece desativado. O aplicativo desktop não tem planos.
Entrar e sair
Comece a trabalhar em uma solicitação em rascunho a partir de qualquer um destes:
- Trabalhar nela agora na caixa de diálogo Nova solicitação de mudança (marcado por padrão).
- Trabalhar nesta solicitação de mudança na página de uma solicitação em rascunho.
- Propor mudança ▾ → Trabalhar em uma solicitação de mudança… na Visão do item de um item. A lista mostra os rascunhos que nomeiam o item, mais Nova solicitação de mudança….
- Trabalhar em uma solicitação de mudança na mensagem mostrada quando você edita um item sob controle de configuração.
- ⌘K / Ctrl+K → Trabalhar em solicitação de mudança….
- Continuar em Meu trabalho → Solicitações de mudança em que estou trabalhando.
Enquanto você trabalha em uma solicitação:
- Um banner sob a barra superior diz, por exemplo, Trabalhando em CR-12 Range upgrade. As edições vão para esta solicitação de mudança, não para o modelo em uso. 3 alterações. com Revisar alterações e Sair.
- O status de salvamento diz, por exemplo, Salvo às 14:02 em CR-12.
- Os itens que a solicitação alterou trazem um marcador SM nas tabelas e nos diagramas.
Para experimentar, abra o projeto de demonstração CubeSat EO-1: CR-1 Shorten the planning cycle é um rascunho com edições feitas nele. Abra-o em Solicitações de mudança e clique em Trabalhar nesta solicitação de mudança. Na demonstração Hybrid Car, CR-2 Clarify the charge time contém uma edição na documentação de um requisito.
Clique em Sair no banner (ou ⌘K / Ctrl+K → Sair da solicitação de mudança) para voltar ao modelo em uso. O modo pertence à aba do navegador: outra aba pode mostrar o modelo em uso ao mesmo tempo, e um recarregamento mantém a aba na solicitação.
O que funciona de forma diferente
- Desfazer para no ponto em que você entrou na solicitação.
- Alterações de esquema, linhas de base, compartilhamento, Solicitar aprovação e Restaurar uma versão anterior são recusados até que você saia da solicitação.
- Itens sob controle de configuração podem ser editados na solicitação; é para isso que ela existe.
- Enviar para revisão pausa as edições até que a solicitação seja decidida ou retirada. Uma solicitação rejeitada volta a ser rascunho quando você a edita.
- Retirar move as edições da solicitação para a Lixeira como uma entrada, por exemplo CR-12 changes; Restaurar as coloca de volta na solicitação.
Revisar as alterações
Uma solicitação com edições feitas nela tem duas abas na página: Detalhes (a solicitação, as alterações preparadas, a revisão, os comentários e o histórico) e Alterações, que compara o modelo antes da solicitação com o modelo tal como a solicitação o deixaria. Revisar alterações no banner a abre.
- Blocos de contagem mostram os itens adicionados, removidos e alterados e as alterações de relacionamentos; abaixo deles, cada alteração tem a própria linha, com o texto alterado mostrado palavra por palavra.
- Resultados de qualidade, marcas de vínculos suspeitos e outros registros de revisão ficam ocultos; clique em Mostrar dados da revisão para listá-los também.
- Documentos lista cada documento que contém um item alterado. Comparar versões… mostra o documento antes da solicitação e com ela, cada campo lado a lado com as palavras alteradas marcadas; uma frase que foi movida dentro de um campo aparece em violeta nos dois lugares, com um vínculo entre eles.
- Diagramas lista cada diagrama alterado com o que mudou, por exemplo Asset Diagram 0 Drone Delivery System: 1 forma adicionada (Charger), 1 movida. Mostrar antes e depois desenha as duas versões lado a lado.
Visualizar no modelo na página da solicitação abre o modelo como ele ficaria depois de a solicitação ser aplicada, somente leitura. O banner diz, por exemplo, Visualizando CR-12 (somente leitura). Todas as páginas mostram a alteração no lugar, de modo que você pode checar uma especificação gerada, a RVTM ou uma matriz. As edições são recusadas até que você clique em Sair. Revisores e leitores também podem visualizar.
Os votos cobrem as edições feitas na solicitação, assim como as alterações preparadas dela: uma edição feita depois de um voto anula esse voto, e os aprovadores decidem novamente.
Aplicar uma solicitação em que você trabalhou
Aplicar alterações em uma solicitação aprovada primeiro compara as edições dela com o modelo em uso tal como está agora, porque outras pessoas podem ter alterado os mesmos itens desde então.
- Sem conflitos: a confirmação diz, por exemplo, Aplicar 14 alterações ao modelo ativo? Um único Desfazer reverte tudo. Após Aplicar alterações, o aviso diz CR-12 aplicada: 14 alterações. Os novos itens mantêm os ids, e o histórico de cada item alterado diz "via CR-12" e nomeia os autores da solicitação.
- Alterações em campos diferentes do mesmo item são mescladas sem perguntar: se a solicitação renomeou um item e outra pessoa alterou o número dele no modelo em uso, as duas alterações são mantidas.
- Conflitos: o mesmo campo alterado nos dois lados, um item excluído em um lado e alterado no outro, ou um vínculo da solicitação para um item excluído no modelo em uso. A página da solicitação os conta, por exemplo CR-12 tem 2 conflitos com o modelo em uso., e Aplicar alterações abre primeiro Resolver conflitos — CR-12.
Em Resolver conflitos, cada item em conflito tem um cartão com a versão do Modelo em uso (no serviço hospedado, com quem a alterou) e a versão da Solicitação de mudança; Mostrar original adiciona a versão de antes de qualquer das alterações. Os diagramas são desenhados lado a lado. Escolha uma das opções:
- Manter atualizado: o item permanece como o modelo em uso o tem. Para um vínculo com um item excluído, o vínculo fica de fora.
- Usar solicitação de mudança: o valor da solicitação para cada campo que ela alterou; os campos que só o modelo em uso alterou mantêm o valor em uso. Para uma exclusão, o resultado da solicitação: o item é excluído, ou restaurado com as alterações da solicitação. Para um vínculo com um item excluído, o item é restaurado da Lixeira com o vínculo.
- Combinar: uma linha por campo alterado com Ao vivo e Solicitação de mudança. Os campos que só um lado alterou começam nesse lado; os campos que ambos alteraram começam em Solicitação de mudança.
Aplicar alterações fica desativado até que cada conflito tenha uma escolha ("Escolha uma versão para cada um dos 3 conflitos."). Somente um aprovador da solicitação que possa editar resolve conflitos; os outros veem, por exemplo, CR-12 tem 3 conflitos com o modelo em uso. Um aprovador os resolve em Aplicar. O Histórico da solicitação registra cada escolha ("Mantida a versão em uso de R.4.2", "Substituída uma alteração em uso de Ann em R.4.3"), e no serviço hospedado a pessoa cuja alteração em uso foi substituída recebe uma notificação.
Um único Desfazer reverte a aplicação inteira: restaura o modelo em uso e coloca a solicitação de volta em Aprovada com as edições dela, pronta para ser aplicada novamente. Após Aplicar, a aba Alterações da solicitação mantém a lista do que foi aplicado. Uma solicitação editada após a aprovação não pode ser aplicada até ser enviada e aprovada novamente. Quem estiver trabalhando na solicitação ou visualizando-a quando ela for aplicada volta ao modelo em uso. Em um projeto SysML v2, a confirmação lista os erros que a solicitação adicionaria ao modelo, e Aplicar alterações fica desativado até que você escolha outra versão ou a solicitação seja rejeitada.
Impacto
Cada alteração preparada tem uma lista de Impacto: os itens rastreados até ela, encontrados antes que alguém aprove ou aplique a alteração. O cabeçalho dela mostra as contagens, por exemplo Impacto 3 afetados · 7 a checar. Clique no cabeçalho para mostrar ou ocultar a lista. Uma solicitação com mais de três alterações começa com as listas fechadas.
A lista é agrupada em Requisitos, Testes e verificação, Interfaces, Documentos, Diagramas, Itens em outros projetos e Outros itens. Cada linha é marcada:
| Marca | Significado |
|---|---|
| Afetado | A alteração o atinge: um item a um relacionamento do item alterado, um documento ou diagrama que mostra o item alterado, as duas pontas de um relacionamento adicionado ou removido, e itens em outros projetos vinculados ao item alterado. |
| Checagem | Um passo além: itens rastreados até um item afetado, os documentos e diagramas que os mostram, e itens em outros projetos a dois vínculos de distância. |
Cada linha nomeia a classe e como é alcançada, por exemplo "verified by 1.1 Pump pressure". Um vínculo com outro projeto cujo item mudou desde a última revisão do vínculo mostra Alterado. Clique em uma linha para abrir o item, o documento ou o diagrama. Os itens em outros projetos vêm do Rastreamento do item, com o seu próprio acesso: os vínculos para projetos que você não pode abrir são apenas contados.
Uma lista mostra no máximo 300 linhas e diz quantas outras existem. Os vínculos com outros projetos são lidos para os primeiros 12 itens alterados.
Sob o cabeçalho, uma nota diz em que a lista se baseia: "O impacto se baseia nos relacionamentos modelados; dependências não vinculadas ou mais distantes podem não aparecer. Calculado em relação à revisão 1.204 às 14:02." A revisão é a revisão do projeto quando a lista foi calculada (no serviço hospedado, o mesmo número para todos os editores). Se o modelo mudar enquanto você lê, a lista permanece como calculada; reabra a solicitação para calculá-la novamente. Uma lista salva mantém a revisão em relação à qual foi calculada.
Quando a solicitação é aplicada, as listas são salvas com ela e mostradas como estavam, de modo que o registro continua dizendo o que foi considerado depois que itens são renomeados ou excluídos. Exportar ▾ → Word (.docx) as inclui, e o log em Excel tem uma coluna Impacto com as contagens.
A mesma lista aparece em outros lugares onde uma alteração aguarda uma decisão:
- Pré-visualizações de IA e propostas de clientes de IA: veja IA.
- Nova liberação… de uma biblioteca: os projetos e itens que usam os itens da biblioteca alterados desde a liberação mais recente; veja Bibliotecas.
- Aprovar um requisito em linha de base: os itens de verificação e os documentos que precisariam de nova revisão; veja Requisitos.
Status
| Status | Significado |
|---|---|
| Draft | Em elaboração; o autor prepara as alterações. |
| Enviada | Aguardando os aprovadores. |
| Em revisão | Pelo menos um aprovador votou. |
| Aprovada | Aprovações suficientes; pronta para aplicar. |
| Rejeitada | Um aprovador a rejeitou; o autor pode revisá-la e enviá-la novamente. |
| Retirada | Encerrada sem alterar o modelo. |
| Implementada | As alterações foram aplicadas. |
Controle de configuração
Nota: no serviço hospedado, vale o plano do proprietário do projeto. O controle de configuração (o primeiro ajuste) vem com os planos Individual e Team; as regras de aprovação abaixo (aprovações exigidas, quem aprova, um comitê de mudança, autoaprovação) vêm com o plano Team. Um endereço de e-mail acadêmico verificado ou a participação em uma organização de turma ativa mantém ambos. Projetos e organizações que os usavam antes da versão 2.29.0 os mantêm. Sem as regras de aprovação, as solicitações de mudança funcionam com uma regra: a aprovação de um proprietário do projeto decide, e o autor pode aprovar a própria solicitação, de modo que você pode aprovar e aplicar as próprias alterações quando trabalha sozinho. Os ajustes salvos antes são mantidos, mas não aplicados, e Ajustes informa isso; itens aprovados e em linha de base podem então ser editados diretamente. Registros de aprovação, votos e status são mantidos. O aplicativo desktop não tem planos.
Ajustes no cabeçalho da página Solicitações de mudança abre Ajustes de solicitações de mudança. Ele agrupa os ajustes em Controle de configuração (o que precisa de uma solicitação de mudança e se os editores trabalham em rascunhos) e Aprovação (quantas aprovações, quem aprova, autoaprovação); cada ajuste se aplica conforme você o altera, e Concluído fecha a caixa de diálogo. A linha acima da lista diz o que os ajustes fazem agora, por exemplo "Itens aprovados e em linha de base podem ser editados diretamente; 1 aprovação por proprietários do projeto.", com um link Alterar em Ajustes.
Em Ajustes, um proprietário do projeto pode ativar Alterações em itens aprovados e em linha de base exigem uma solicitação de mudança. Então:
- Requisitos aprovados (Status Approved) e itens na linha de base mais recente do projeto não podem mais ser editados, excluídos ou vinculados diretamente. O Holarch explica o motivo e aponta para as solicitações de mudança.
- O Aplica-se a, a Efetividade e o pertencimento a configurações (linhas de produtos) também fazem parte deles: alterar a quais configurações ou unidades um item se aplica precisa de uma solicitação de mudança.
- Comentários, revisões, aprovações de requisitos, resultados de qualidade e marcas de revisão de vínculos continuam abertos.
- As solicitações de mudança aprovadas aplicam as alterações a esses itens.
- A API REST e o MCP seguem a mesma regra: a alteração direta de um script nesses itens é recusada (
409 change-control), e a proposta de um cliente de IA não pode incluí-los. Proponha a alteração em uma solicitação de mudança. - No serviço hospedado, o servidor checa cada alteração que chega a ele, também as alterações feitas offline. Uma alteração em um item aprovado ou em linha de base que foi feita antes de o item ficar sob controle (offline, ou enquanto outra pessoa o aprovava) não é salva: o Holarch diz qual item era, recarrega o projeto e mantém suas outras alterações. Proponha essa alteração em uma solicitação de mudança.
Nota: no serviço hospedado, o controle de configuração é imposto pelo servidor para todas as formas de edição (o aplicativo, a API REST e o MCP); um editor não pode contorná-lo com outro cliente. Somente a aplicação de uma solicitação de mudança aprovada altera esses itens. No aplicativo desktop e em projetos do navegador, o aplicativo o impõe, como faz com os bloqueios de itens.
Aprovações e aprovadores
- Aprovações exigidas: 1, 2 ou 3.
- Quem aprova: Proprietários do projeto, Proprietários e editores ou Um comitê de mudança de membros nomeados do projeto (serviço hospedado; no desktop você aprova as próprias solicitações). Um comitê de mudança pode incluir Revisores: eles aprovam, rejeitam e comentam a solicitação sem poder editar o modelo. Todo membro do projeto que pode comentar (Revisor ou acima) pode comentar uma solicitação de mudança.
- Os autores podem aprovar suas próprias solicitações de mudança: desativado por padrão.
Somente os proprietários do projeto alteram esses ajustes.
Os mesmos ajustes se aplicam às solicitações que um fluxo de trabalho cria: uma mudança de estado marcada com Aprovação em Esquema → Fluxo de trabalho abre Solicitar aprovação, que cria e envia uma solicitação de mudança com essa única alteração.
Uma transição de fluxo de trabalho pode nomear os próprios aprovadores, por exemplo todos os membros de um comitê de revisão, ou 2 de 4 engenheiros nomeados (Escolher os aprovadores de uma transição). Uma solicitação então precisa das aprovações de cada regra em que as mudanças de estado dela se enquadram; as alterações que nenhuma transição cobre usam estes ajustes. No aplicativo desktop, os aprovadores são nomes: você aprova com o nome em Preferências → Seu nome. Uma solicitação que contém apenas mudanças de estado é aplicada com a última aprovação quando esse aprovador pode editar.
No serviço hospedado, o Holarch usa apenas os ajustes que um proprietário do projeto salvou; os ajustes alterados por qualquer outra pessoa são ignorados e os padrões se aplicam (os proprietários aprovam, uma aprovação, não as próprias solicitações).
Quando o Holarch não tem registro de quem enviou uma solicitação de mudança, por exemplo em um projeto enviado ou importado com as solicitações dele, somente um proprietário do projeto pode aprová-la. Os ajustes sem registro de quem os salvou se aplicam com os proprietários como aprovadores e sem autoaprovação até que um proprietário os salve novamente.
Registros de aprovação
No serviço hospedado, aprovar ou rejeitar pede a sua senha (uma vez a cada 10 minutos) e registra quem decidiu, quando, a nota e as alterações preparadas exatas às quais o voto se aplica. Se as alterações preparadas forem editadas depois de um voto, esse voto deixa de contar e os aprovadores são consultados novamente. Antes de as alterações serem aplicadas, o servidor checa se a solicitação está aprovada com as alterações atuais. Cada voto também é gravado no log de auditoria (solicitação, decisão e o tamanho da nota; não a nota em si).
Nota: um registro de aprovação mostra quem aprovou o quê e quando. Não é uma assinatura eletrônica regulamentada por lei (como uma sob a 21 CFR Part 11).
Comentários, avisos e o log
- Os Comentários em uma solicitação de mudança funcionam como os comentários em itens.
- No serviço hospedado, os avisos vão para os aprovadores quando uma solicitação é enviada, para o autor quando ela é aprovada ou rejeitada, e para o autor e os votantes quando ela é aplicada ou retirada.
- Cada solicitação mantém um Histórico do que aconteceu, por quem e quando.
- Exportar ▾ na página Solicitações de mudança (mostrado assim que existe uma solicitação de mudança) salva o log de solicitações de mudança como Excel (.xlsx) ou Word (.docx), com as alterações e o histórico de cada solicitação.