{"id":76463,"date":"2020-04-02T13:42:40","date_gmt":"2020-04-02T11:42:40","guid":{"rendered":"https:\/\/prohoster.info\/blog\/administrirovanie\/proektirovanie-v-confluence"},"modified":"2020-04-02T13:42:40","modified_gmt":"2020-04-02T11:42:40","slug":"proektirovanie-v-confluence","status":"publish","type":"post","link":"https:\/\/prohoster.info\/pt\/blog\/administrirovanie\/proektirovanie-v-confluence","title":{"rendered":"Designing in Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

Ol\u00e1 a todos! <\/p>\n

Meu nome \u00e9 Masha, sou engenheira de qualidade no grupo de empresas Tinkoff. O trabalho de QA envolve muitas comunica\u00e7\u00f5es com diferentes pessoas de diferentes equipes, e como tamb\u00e9m fui gerente e palestrante de programas educacionais, meu mapa de comunica\u00e7\u00f5es era o mais amplo poss\u00edvel. E em algum momento, eu explodi: percebi que n\u00e3o podia mais, n\u00e3o podia mais, n\u00e3o podia mais preencher montanhas infernais de tabelas e documentos ileg\u00edveis. <\/p>\n

\"Designing
\n
\n<\/a><\/noindex>
\nCom certeza, cada um de voc\u00eas agora imaginou o que estou dizendo e come\u00e7ou a suar frio: listas de nomes sem ordem alfab\u00e9tica, tabelas com centenas de colunas com formata\u00e7\u00e3o desalinhada, tabelas com milhares de linhas, onde voc\u00ea precisa usar o dedo na roda do mouse para ver o cabe\u00e7alho, toneladas de p\u00e1ginas de instru\u00e7\u00f5es n\u00e3o numeradas, centenas de e-mails reenviados com dados que precisam ser analisados e sistematizados e colocados em tabelas igualmente ileg\u00edveis.<\/p>\n

\"Designing
\n
\nE ent\u00e3o, quando eu estava um pouco mais calma, decidi escrever este artigo. Vou falar sobre como \u00e9 poss\u00edvel gerenciar a documenta\u00e7\u00e3o n\u00e3o produtiva de forma normal (e \u00e0s vezes at\u00e9 conveniente). Espero que o artigo se espalhe pela rede e que o n\u00edvel de confus\u00e3o nos departamentos adjacentes ao desenvolvimento diminua um pouco, e que as pessoas (incluindo eu) fiquem um pouquinho mais felizes.<\/p>\n

\"Designing
\n<\/p>\n

Ferramentas<\/h2>\n

\nA documenta\u00e7\u00e3o produtiva geralmente \u00e9 armazenada pr\u00f3xima ao c\u00f3digo, e isso \u00e9 bom. J\u00e1 a documenta\u00e7\u00e3o n\u00e3o produtiva costuma ser armazenada em qualquer lugar. Muitas vezes, as pessoas tentam transferir informa\u00e7\u00f5es de diferentes lugares para o Confluence, e n\u00f3s n\u00e3o somos exce\u00e7\u00e3o. Ent\u00e3o, aqui vai toda a hist\u00f3ria sobre ele.<\/p>\n

Na verdade, o Confluence \u00e9 um motor de wiki avan\u00e7ado. Ele permite trabalhar com dados em diferentes formatos de exibi\u00e7\u00e3o: texto formatado, tabelas, v\u00e1rios tipos de diagramas. \u00c9 uma ferramenta muito interessante e poderosa, mas se voc\u00ea n\u00e3o souber como us\u00e1-la, acabar\u00e1 com mais uma pilha de documentos ileg\u00edveis. Vou ensinar voc\u00eas a us\u00e1-la!<\/p>\n

\"Designing
\n<\/p>\n

Macros<\/h2>\n

\nQuase toda a m\u00e1gica do Confluence \u00e9 constru\u00edda em torno de macros. Existem muitas macros, e elas podem ser combinadas entre si. Algumas s\u00e3o pagas e outras s\u00e3o gratuitas, e a seguir haver\u00e1 diferentes exemplos de macros com links para a documenta\u00e7\u00e3o correspondente.<\/p>\n

A interface para trabalhar com macros \u00e9 extremamente simples. Para adicionar uma macro, voc\u00ea deve clicar no sinal de mais e escolher o elemento desejado na lista.<\/p>\n

\"Designing
\n
\nSe o macro \u00e9 autossuficiente, ou seja, n\u00e3o precisa de nada mais inserido dentro dele, ele parece um bloco.<\/p>\n

\"Designing
\n
\nSe o funcionamento do macro requer que algo seja inserido dentro dele, ele se parece com uma moldura.<\/p>\n

\"Designing
\n
\nDentro de uma moldura, \u00e9 poss\u00edvel colocar quantos outros elementos desejar, desde que haja l\u00f3gica na sua pir\u00e2mide.<\/p>\n

\"Designing
\n
\nCada macro tem uma pr\u00e9-visualiza\u00e7\u00e3o: nela, voc\u00ea pode ver imediatamente se preencheu e configurou o macro corretamente.<\/p>\n

Modelos<\/h2>\n

\nAl\u00e9m dos macros, h\u00e1 uma ferramenta conveniente de preenchimento autom\u00e1tico de conte\u00fado \u2014 o modelo.
\nOs modelos podem ser usados na cria\u00e7\u00e3o de qualquer p\u00e1gina: basta clicar nos tr\u00eas pontos ao lado do bot\u00e3o 'Criar' e selecionar o modelo desejado.<\/p>\n

\"Designing
\n
\nAssim, todo o conte\u00fado presente no modelo ser\u00e1 adicionado \u00e0 p\u00e1gina criada.<\/p>\n

Qualquer um pode criar p\u00e1ginas a partir de modelos, mas apenas aqueles que t\u00eam permiss\u00e3o podem criar ou editar os pr\u00f3prios modelos. No modelo, \u00e9 poss\u00edvel adicionar instru\u00e7\u00f5es adicionais sobre como gerenciar a p\u00e1gina.<\/p>\n

\"Designing
\n<\/p>\n

A Magia das Tabelas<\/h2>\n

\nComo t\u00e9cnico, eu realmente amo tabelas e consigo organizar quase qualquer informa\u00e7\u00e3o nelas (embora isso nem sempre seja eficaz). Por si mesmas, as tabelas s\u00e3o claras, estruturadas, escal\u00e1veis, m\u00e1gicas!<\/p>\n

\"Designing
\n
\nMas at\u00e9 mesmo uma entidade t\u00e3o maravilhosa quanto a tabela pode ser estragada. No entanto, ela pode ser usada de maneira eficaz e at\u00e9 melhorada. Sobre isso, falaremos a seguir.<\/p>\n

Filtragem (plugin pago)<\/h3>\n

\nQualquer tabela enorme e ileg\u00edvel pode ser tornada um pouco menos imensa e um pouco mais leg\u00edvel atrav\u00e9s da filtragem. Para isso, pode-se usar um macro pago. \u2018Filtro de Tabelas\u2019<\/a><\/noindex>.<\/p>\n

Dentro desse macro, \u00e9 necess\u00e1rio inserir a tabela (pode at\u00e9 ser a mais feia, o importante \u00e9 engoli-la por completo). No macro, voc\u00ea pode escolher as colunas para filtragem atrav\u00e9s de uma lista suspensa, filtro de texto, filtro num\u00e9rico e filtro por datas. <\/p>\n

\"Designing
\n
\nImagine que todas as informa\u00e7\u00f5es sobre candidatos a todas as vagas s\u00e3o registradas em uma lista tabular. Naturalmente, n\u00e3o ordenada \u2014 as pessoas n\u00e3o v\u00eam a entrevistas em ordem alfab\u00e9tica. E voc\u00ea precisa entender se j\u00e1 entrevistou um candidato espec\u00edfico antes. Basta inserir essa bagun\u00e7a no macro de filtro, adicionar um filtro de texto pelo sobrenome \u2014 e voil\u00e0, a informa\u00e7\u00e3o est\u00e1 na sua tela.<\/p>\n

\"Designing
\n
\nVale ressaltar que a filtragem de grandes tabelas pode impactar o desempenho do sistema e o tempo de carregamento das p\u00e1ginas. Portanto, utilizar uma grande tabela em um filtro \u00e9 uma solu\u00e7\u00e3o tempor\u00e1ria. \u00c9 melhor estabelecer um processo em que as pessoas n\u00e3o precisem criar tabelas enormes e ileg\u00edveis (um exemplo desse processo ser\u00e1 apresentado no final do artigo).<\/p>\n

Ordena\u00e7\u00e3o (plugin pago)<\/h3>\n

\nCom a ajuda de um macro m\u00e1gico \u2018Filtro de Tabelas\u2019<\/a><\/noindex> tamb\u00e9m \u00e9 poss\u00edvel definir a ordena\u00e7\u00e3o padr\u00e3o por qualquer coluna e numerar as linhas. Ou clicar em qualquer coluna da tabela que est\u00e1 no macro de filtro, e a ordena\u00e7\u00e3o acontecer\u00e1 por essa coluna. <\/p>\n

\"Designing
\n
\nPor exemplo, voc\u00ea tem a mesma tabela com candidatos e precisa estimar quantas entrevistas foram realizadas em um determinado m\u00eas - ordene por data e aproveite.<\/p>\n

Tabelas din\u00e2micas (plugin pago)<\/h3>\n

\nAgora vamos para um caso mais interessante. Imagine que sua tabela \u00e9 enorme e voc\u00ea precisa fazer algum c\u00e1lculo com ela. Claro, voc\u00ea pode copiar para o Excel, calcular o que precisa e reimportar os dados de volta para o Confluence. Ou voc\u00ea pode aplicar uma vez o macro \u00abTabela din\u00e2mica\u00bb<\/a><\/noindex> e obter o mesmo resultado, mas com a vantagem de ser atualizado.<\/p>\n

Por exemplo: voc\u00ea tem uma tabela que cont\u00e9m dados de todos os funcion\u00e1rios - onde eles est\u00e3o localizados e quais cargos ocupam. Para calcular quantas pessoas est\u00e3o em cada cidade, voc\u00ea precisa selecionar no macro \u00abTabela din\u00e2mica\u00bb a linha pela qual os dados ser\u00e3o agregados (localiza\u00e7\u00e3o) e o tipo de opera\u00e7\u00e3o (adi\u00e7\u00e3o).<\/p>\n

\"Designing
\n
\nNaturalmente, \u00e9 poss\u00edvel agrupar por diversos crit\u00e9rios ao mesmo tempo; todas as op\u00e7\u00f5es podem ser consultadas na documenta\u00e7\u00e3o<\/a><\/noindex>.<\/p>\n

Gr\u00e1ficos (plugin pago)<\/h3>\n

\nComo j\u00e1 mencionei, nem todos gostam de tabelas tanto quanto eu. Infelizmente, na sua maioria, os gerentes n\u00e3o as apreciam. Por\u00e9m, todos adoram gr\u00e1ficos coloridos e vibrantes.
\nOs criadores do Confluence certamente sabiam disso (eles provavelmente tamb\u00e9m t\u00eam chefes que adoram relat\u00f3rios e gr\u00e1ficos, o que n\u00e3o poderia faltar). Assim, voc\u00ea pode usar o macro m\u00e1gico \u00abGr\u00e1fico da tabela\u00bb<\/a><\/noindex>. Neste macro, voc\u00ea deve inserir a tabela din\u00e2mica do item anterior, e voil\u00e0 - seus dados cinzentos e entediantes s\u00e3o lindamente visualizados.<\/p>\n

\"Designing
\n
\nNaturalmente, h\u00e1 op\u00e7\u00f5es de configura\u00e7\u00e3o nesse macro tamb\u00e9m. O link para a documenta\u00e7\u00e3o de qualquer macro pode ser encontrado no modo de edi\u00e7\u00e3o desse macro.<\/p>\n

Facilidade de agrega\u00e7\u00e3o<\/h2>\n

\nAs informa\u00e7\u00f5es dos pontos anteriores certamente n\u00e3o foram uma revela\u00e7\u00e3o para voc\u00ea. Mas agora voc\u00ea sabe definitivamente como usar macros, e eu posso passar para a parte mais interessante do artigo.<\/p>\n

\"Designing
\n<\/p>\n

Etiquetas<\/h3>\n

\n\u00c9 ruim quando as pessoas guardam informa\u00e7\u00f5es em um \u00fanico artigo n\u00e3o estruturado ou em uma imensa tabela. Pior ainda \u00e9 quando partes dessas informa\u00e7\u00f5es n\u00e3o apenas est\u00e3o mal organizadas, mas tamb\u00e9m espalhadas por diferentes \u00e1reas do Confluence. Felizmente, existe a possibilidade de reunir as informa\u00e7\u00f5es dispersas em um s\u00f3 lugar. Para isso, \u00e9 necess\u00e1rio usar tags<\/a><\/noindex> (as mesmas que todos conhecem das redes sociais).<\/p>\n

\"Designing
\n
\nQualquer p\u00e1gina pode ter um n\u00famero ilimitado de tags adicionadas. Se voc\u00ea clicar em uma tag, ser\u00e1 direcionado a uma p\u00e1gina de agrega\u00e7\u00e3o, onde encontrar\u00e1 links para todos os materiais com essa tag, al\u00e9m de um conjunto de tags relacionadas. As tags relacionadas s\u00e3o aquelas que costumam aparecer em uma mesma p\u00e1gina.<\/p>\n

\"Designing
\n<\/p>\n

Propriedades das p\u00e1ginas<\/h3>\n

\nVoc\u00ea tamb\u00e9m pode adicionar outra macro interessante para estruturar informa\u00e7\u00f5es \u00e0 p\u00e1gina \u2014 \"Propriedades das p\u00e1ginas\"<\/a><\/noindex>. Dentro dela, voc\u00ea deve inserir uma tabela de duas colunas, sendo a primeira a chave e a segunda o valor da propriedade. Al\u00e9m disso, a macro pode ser ocultada da p\u00e1gina, para que n\u00e3o atrapalhe a leitura do conte\u00fado, mas a p\u00e1gina ainda assim ser\u00e1 marcada com as chaves necess\u00e1rias.<\/p>\n

\"Designing
\n
\nPreste aten\u00e7\u00e3o no ID \u2014 \u00e9 conveniente defini-lo para associar diferentes grupos de propriedades a diferentes p\u00e1ginas (ou at\u00e9 mesmo diferentes grupos de propriedades em uma \u00fanica p\u00e1gina). <\/p>\n

Relat\u00f3rios<\/h3>\n

\nRelat\u00f3rios podem ser gerados por meio das tags. Por exemplo, a macro \"Relat\u00f3rio de Conte\u00fado\"<\/a><\/noindex> coleta todas as p\u00e1ginas com um conjunto espec\u00edfico de tags.<\/p>\n

\"Designing
\n
\nMas um relat\u00f3rio mais interessante \u00e9 a macro \"Relat\u00f3rio por Propriedades da P\u00e1gina\"<\/a><\/noindex>. Ela tamb\u00e9m agrega todas as p\u00e1ginas com um determinado conjunto de tags, mas n\u00e3o apenas apresenta uma lista, e sim comp\u00f5e uma tabela (voc\u00ea percebe a conex\u00e3o com o come\u00e7o do artigo?), onde as colunas s\u00e3o as chaves das propriedades da p\u00e1gina.<\/p>\n

\"Designing
\n
\nAssim, obt\u00e9m-se uma tabela resumo com informa\u00e7\u00f5es de diferentes fontes. \u00c9 agrad\u00e1vel que ela possua fun\u00e7\u00f5es pr\u00e1ticas: layout responsivo, ordena\u00e7\u00e3o por qualquer coluna. Al\u00e9m disso, essa tabela de relat\u00f3rio pode ser configurada dentro da macro. <\/p>\n

\"Designing
\n
\nAo configurar, \u00e9 poss\u00edvel remover algumas colunas do relat\u00f3rio, definir um estado padr\u00e3o ou a quantidade de registros exibidos. Tamb\u00e9m \u00e9 poss\u00edvel definir o ID da propriedade da p\u00e1gina, para visualizar apenas as informa\u00e7\u00f5es desejadas.<\/p>\n

Por exemplo, voc\u00ea tem v\u00e1rias p\u00e1ginas de funcion\u00e1rios, e essas p\u00e1ginas t\u00eam um conjunto de propriedades sobre a pessoa: qual \u00e9 o seu n\u00edvel, onde est\u00e1 localizado, quando entrou na equipe e assim por diante. Essas propriedades s\u00e3o marcadas ID = employee_inf<\/i>. E h\u00e1 um segundo conjunto de propriedades na mesma p\u00e1gina, que re\u00fane informa\u00e7\u00f5es sobre a pessoa como parte da equipe: qual o papel que a pessoa desempenha, em que equipe est\u00e1 e assim por diante. Essas propriedades s\u00e3o marcadas ID = team_inf<\/i>. Ent\u00e3o, ao compor um relat\u00f3rio, voc\u00ea pode extrair informa\u00e7\u00f5es de um \u00fanico ID ou de ambos \u2014 como for mais conveniente.<\/p>\n

A beleza desse approach \u00e9 que cada um pode compor a tabela de informa\u00e7\u00f5es que precisar, que n\u00e3o ser\u00e1 duplicada e ser\u00e1 atualizada quando a p\u00e1gina principal for modificada. Por exemplo: para um l\u00edder de equipe, n\u00e3o importa quando seus desenvolvedores foram contratados, mas sim qual papel cada um desempenha na equipe. O l\u00edder de equipe coletar\u00e1 um relat\u00f3rio da equipe. E para o contador, n\u00e3o importa quem desempenha qual papel, mas as fun\u00e7\u00f5es s\u00e3o importantes \u2014 ele coletar\u00e1 um relat\u00f3rio por fun\u00e7\u00f5es. Enquanto isso, a fonte da informa\u00e7\u00e3o n\u00e3o ser\u00e1 duplicada ou movida.<\/p>\n

O processo final<\/h2>\n

<\/p>\n

Instru\u00e7\u00e3o<\/h3>\n

\nAssim, podemos estruturar de forma bonita e agregar informa\u00e7\u00f5es de maneira eficiente no Confluence, usando o exemplo do uso de macros. Mas, idealmente, deve-se fazer com que novas informa\u00e7\u00f5es sejam imediatamente estruturadas e se encaixem em todos os mecanismos de agrega\u00e7\u00e3o j\u00e1 utilizados.<\/p>\n

Aqui, a combina\u00e7\u00e3o de macros e templates ajudar\u00e1. Para for\u00e7ar as pessoas a criarem novas p\u00e1ginas no formato desejado, pode-se usar a macro \"Criar a partir de template\". Ela adiciona um bot\u00e3o \u00e0 p\u00e1gina, que ao ser clicado cria uma nova p\u00e1gina a partir do template que voc\u00ea deseja. Dessa forma, voc\u00ea faz com que as pessoas trabalhem imediatamente no formato que voc\u00ea precisa. <\/p>\n

\"Designing
\n
\nNo template do qual voc\u00ea permite a cria\u00e7\u00e3o de uma p\u00e1gina, \u00e9 necess\u00e1rio adicionar previamente tags, a macro \"Propriedades da p\u00e1gina\" e a tabela das propriedades desejadas. Tamb\u00e9m recomendo adicionar instru\u00e7\u00f5es sobre quais valores devem ser preenchidos na p\u00e1gina e os valores das propriedades.<\/p>\n

\"Designing
\n
\nEnt\u00e3o, o processo final ser\u00e1 assim:<\/p>\n

    \n
  1. Voc\u00ea cria um template para informa\u00e7\u00f5es de certo tipo.<\/li>\n
  2. Nesse template, voc\u00ea adiciona tags e propriedades da p\u00e1gina na macro.<\/li>\n
  3. Em qualquer lugar conveniente, voc\u00ea cria uma p\u00e1gina raiz com um bot\u00e3o que, ao ser clicado, gera uma p\u00e1gina filha a partir do modelo. <\/li>\n
  4. Voc\u00ea libera na p\u00e1gina raiz usu\u00e1rios que potencialmente ir\u00e3o gerar as informa\u00e7\u00f5es necess\u00e1rias (de acordo com o modelo, clicando no bot\u00e3o).<\/li>\n
  5. Voc\u00ea coleta um relat\u00f3rio sobre as propriedades da p\u00e1gina atrav\u00e9s das etiquetas que voc\u00ea especificou no modelo.<\/li>\n
  6. Voc\u00ea fica contente: voc\u00ea possui todas as informa\u00e7\u00f5es necess\u00e1rias em um formato conveniente. <\/li>\n<\/ol>\n

    \"Designing
    \n<\/p>\n

    Pontos cr\u00edticos<\/h3>\n

    \nComo engenheiro de qualidade, posso afirmar com seguran\u00e7a que nada \u00e9 perfeito no mundo. At\u00e9 mesmo as tabelas divinas s\u00e3o imperfeitas. E no processo mencionado acima, h\u00e1 pontos cr\u00edticos.<\/p>\n