Ola a todos!
Chámome Masha, traballo como enxeñeiro de garantía de calidade no grupo de empresas Tinkoff. O traballo de control de calidade implica moita comunicación con diferentes persoas de diferentes equipos, e tamén fun xestor e profesor de programas educativos, polo que o meu mapa de comunicación era o máis amplo posible. E nalgún momento estoupei: decateime de que xa non podo, non podo, non podo encher toneladas infernais de táboas e documentos ilexíbeis.
Seguro que agora cada un de vós imaxinabades o que estou a falar, e suor fría: listas de apelidos sen orde alfabética, táboas con centos de columnas cunha disposición desleixoada, táboas con miles de liñas nas que cómpre borrar o dedo. na roda do rato para mirar o título, toneladas de páxinas de instrucións sen numerar, centos de cartas enviadas entre si con datos que hai que analizar e sistematizar e encherlas nas mesmas táboas ilexíbeis.
E así, cando me arrefriei un pouco, decidín escribir este artigo. Falarei sobre como pode manter normalmente (incluso ás veces convenientemente) unha variedade de documentación non relacionada co produto. Espero que o artigo se espalle pola rede e que o nivel de inferno nos departamentos adxacentes ao desenvolvemento baixe polo menos un pouco e a xente (incluíndo eu) sexa un pouco máis feliz.
Ferramentas
A documentación do produto adoita gardarse xunto co código, o que é bo. E a documentación non relacionada co produto adoita almacenarse en calquera lugar. Moitas veces a xente tenta traer información de diferentes lugares a Confluence, e nós non somos unha excepción. Así que o resto da historia vai sobre el.
En xeral, Confluence é un motor wiki avanzado. Permite traballar con datos en diferentes tipos de visualización: texto con formato, táboas, gráficos diversos. Esta é unha ferramenta moi interesante e poderosa, pero se non sabes como cociñala, terás outro vertedoiro de documentos ilexíbeis. Ensinareiche a cociñar!
macros
Case toda a maxia de Confluence está construída arredor de macros. Hai moitas macros e pódense combinar entre si. Son de pago e gratuítos, ademais haberá varios exemplos de macros con ligazóns a documentación para elas.
A interface para traballar con macros é o máis sinxela posible. Para engadir unha macro, cómpre facer clic no plus e seleccionar o elemento desexado da lista.
Se a macro é autosuficiente, é dicir, non require a inserción de outra cousa no seu interior, parece un bloque.
Se unha macro necesita algo dentro dela para funcionar, parece unha caixa.
Ao mesmo tempo, podes poñer tantos outros como queiras dentro dun marco, sempre que haxa lóxica na túa pirámide.
Cada macro ten unha vista previa: mostra inmediatamente se encheu e configuraches a macro correctamente.
templates
Ademais das macros, hai unha ferramenta conveniente para encher o contido previamente: este é un modelo.
Os modelos pódense utilizar ao crear calquera páxina: só tes que facer clic nos tres puntos situados a carón do botón "Crear" e seleccionar o modelo desexado.
Despois, todo o contido que estea no modelo engadirase á páxina creada.
Calquera persoa pode crear páxinas a partir de modelos, pero só poden crear páxinas aqueles que teñan os dereitos para crear ou editar modelos. Podes engadir instrucións adicionais ao modelo sobre como se debe manter a páxina.
Mesa máxica
En realidade, como técnico, encántanme moito as táboas e podo envolver nelas case calquera información (aínda que isto non sempre é eficaz). As táboas en si son claras, estruturadas, escalables, máxicas!
Pero incluso unha entidade tan marabillosa como unha mesa pode estropearse. E pódese usar con éxito e mesmo mellorar. Máis sobre iso a continuación.
Filtrado (complemento de pago)
Calquera táboa enorme ilexible pódese facer un pouco menos grande e un pouco máis lexible mediante o filtrado. Para iso, pode usar unha macro de pago .
Dentro desta macro, cómpre meter unha mesa (incluso a máis fea é posible, o principal é empurrala por completo). Na macro, pode seleccionar columnas para o filtro despregable, o filtro de texto, o filtro numérico e o filtro de data.
Imaxine que toda a información sobre os candidatos para todas as prazas está rexistrada nunha lista de táboas. Por suposto, sen clasificar: as persoas non veñen ás entrevistas por orde alfabética. E cómpre entender se entrevistou antes a un candidato específico. Só tes que poñer este inferno nunha macro de filtro, engadir un filtro de texto polo apelido e listo, a información está na túa pantalla.
Cómpre sinalar que filtrar táboas enormes pode afectar o rendemento do sistema e o tempo de carga da páxina, polo que poñer unha táboa enorme no filtro é unha muleta temporal, é mellor construír un proceso no que a xente non teña que crear grandes táboas ilexíbeis (unha exemplo do proceso estará ao final do artigo).
Clasificación (complemento de pago)
Con Magic Macro tamén pode establecer a ordenación predeterminada en calquera columna e numerar as filas. Ou faga clic en calquera columna da táboa colocada na macro de filtro e realizarase a clasificación por esta columna.
Por exemplo, tes a mesma táboa cos candidatos e cómpre descubrir cantas entrevistas se realizaron nun mes determinado, ordena por data e alégrate.
Táboas dinámicas (complemento de pago)
Agora pasemos a un caso máis interesante. Imaxina que a túa táboa é enorme e necesitas calcular algo sobre ela. Por suposto, pode copialo en Excel, calcular o que precisa e cargar os datos de novo a Confluence. Podes aplicar unha macro unha vez? e obtén o mesmo resultado, só actualizado.
Por exemplo: tes unha táboa que contén os datos de todos os empregados: onde se atopan xeograficamente e que postos ocupan. Para calcular cantas persoas hai en cada cidade, cómpre seleccionar na macro "Táboa dinámica" a fila pola que se agregan os datos (localización) e o tipo de operación (adición).
Por suposto, podes agrupar segundo varios criterios á vez, podes ver todas as posibilidades .
Gráficos (complemento de pago)
Como dixen, non todo o mundo quere as mesas tanto coma min. Desafortunadamente, á maioría dos xestores non lles gustan nada. Pero todos adoran as cartas de cores brillantes.
Os creadores de Confluence seguro que o sabían (seguro que tamén teñen xefes que adoran os informes e as listas, onde estarían sen el). Polo tanto, pode usar a macro máxica . Nesta macro, cómpre poñer a táboa dinámica do parágrafo anterior e listo: os teus aburridos datos grises visualízanse moi ben.
Por suposto, esta macro tamén ten axustes. No modo de edición desa macro pódese atopar unha ligazón á documentación de calquera macro.
Facilidade de agregación
A información dos parágrafos anteriores probablemente non fose unha revelación para ti. Pero agora definitivamente sabes como usar as macros, e podo pasar á parte máis interesante do artigo.
Etiquetas
É malo cando a xente almacena información nun artigo non estruturado ou nunha táboa enorme. Peor aínda é cando partes desta información non só son ilexíbeis, senón que tamén están espalladas polas extensións de Confluence. Afortunadamente, é posible recoller información dispersa nun só lugar. Para iso cómpre usar (etiquetas coñecidas para todos nas redes sociais).
Pódese engadir calquera número de etiquetas a calquera páxina. Facendo clic nunha etiqueta levarache a unha páxina de agregación con ligazóns a todo o contido con esa etiqueta, así como a un conxunto de etiquetas relacionadas. As etiquetas relacionadas son as que aparecen con frecuencia na mesma páxina.
Propiedades da páxina
Podes engadir outra macro interesante á páxina para estruturar a información - . Dentro del, cómpre enviar unha táboa de dúas columnas, a primeira será a clave e a segunda será o valor da propiedade. Ademais, a macro pódese ocultar da páxina para que non interfira coa lectura do contido, pero a páxina aínda estará marcada coas claves necesarias.
Preste atención ao ID: é conveniente configuralo para colgar diferentes grupos de propiedades en diferentes páxinas (ou incluso diferentes grupos de propiedades nunha mesma páxina).
informes
Mediante etiquetas, pode recoller informes. Por exemplo, macro recolle todas as páxinas cun determinado conxunto de etiquetas.
Pero un informe máis interesante é unha macro . Tamén recolle todas as páxinas cun determinado conxunto de etiquetas, pero non só as enumera, senón que compila unha táboa (captas a conexión co comezo do artigo?), na que as columnas son as claves das propiedades da páxina.
Resulta un cadro resumo de información de diferentes fontes. É bo que teña características convenientes: deseño adaptativo, clasificación por calquera columna. Ademais, esta táboa de informes pódese configurar dentro da macro.
Ao configurar, pode eliminar algunhas columnas do informe, establecer o estado predeterminado ou o número de rexistros mostrados. Tamén pode configurar o ID da propiedade da páxina para ver só a información que precisa.
Por exemplo, tes moitas páxinas de empregados, estas páxinas teñen un conxunto de propiedades sobre unha persoa: que nivel está, onde está, cando se uniu ao equipo, etc. Estas propiedades están marcadas id = employee_inf. E hai un segundo conxunto de propiedades na mesma páxina, que contén información sobre unha persoa como parte dun equipo: que papel desempeña a persoa, en que equipo está, etc. Estas propiedades están marcadas ID = team_inf. Despois, ao compilar un informe, só pode mostrar información para un ou dous ID á vez, o que sexa máis conveniente.
A beleza deste enfoque é que todos poden recoller a táboa de información que precisa, que non duplicará nada e actualizarase cando se actualice a páxina principal. Por exemplo: a un líder de equipo non lle importa cando os seus desenvolvedores conseguiron un traballo, pero é importante o papel que xoga cada un deles no equipo. O xefe do equipo recollerá un informe sobre o equipo. E ao contable non lle importa quen desempeña o papel, pero os postos son importantes: recollerá un informe sobre os postos. Neste caso, a fonte de información non será duplicada nin transferida.
Proceso final
Instrución
Polo tanto, podemos estruturar e agregar información de forma xenial en Confluence usando macros como exemplo. Pero, idealmente, cómpre asegurarse de que a nova información estea estruturada de inmediato e entre en todos os mecanismos de agregación que xa están en uso.
Aquí un montón de macros e modelos virán ao rescate. Para que a xente cree páxinas novas no formato correcto, podes usar a macro Crear a partir dun modelo. Engade un botón á páxina, facendo clic en que se crea unha nova páxina a partir do modelo que necesitas. Deste xeito, fai que a xente traballe inmediatamente no formato que necesites.
No modelo desde o que permites crear unha páxina, cómpre engadir etiquetas, a macro "Propiedades da páxina" e unha táboa das propiedades que necesitas previamente. Tamén recomendo engadir instrucións sobre os valores para encher a páxina e os valores das propiedades.
A continuación, o proceso final será así:
- Está a crear un modelo para un tipo específico de información.
- Neste modelo, engade etiquetas e propiedades de páxina nunha macro.
- En calquera lugar conveniente, cree unha páxina raíz cun botón, facendo clic na que se crea unha páxina filla a partir do modelo.
- Inicie na páxina raíz dos usuarios que potencialmente xerarán a información necesaria (segundo o modelo desexado, facendo clic no botón).
- Recolle un informe sobre as propiedades da páxina a través das etiquetas que especificaches no modelo.
- Alégrate: tes toda a información que necesitas nun formato cómodo.
Trampas
Como enxeñeiro de calidade, podo dicir con seguridade que non hai nada perfecto no mundo. Mesmo as táboas divinas son imperfectas. E hai trampas no proceso anterior.
- Se decide cambiar os nomes ou a composición das propiedades da páxina, terá que actualizar todos os obxectos xa creados para que os seus datos sexan incorporados correctamente ao informe de resumo. Isto é triste, pero por outra banda, obrígache a pensar en detalle na "arquitectura" do teu conxunto de información, que é unha tarefa moi interesante.
- Terá que escribir unha cantidade decente de instrucións sobre como cubrir as táboas de información e utilizar as etiquetas. Pero, por outra banda, pode simplemente lanzar este artigo a todas as persoas adecuadas.
Un exemplo de almacenamento de documentación non relacionada co produto
A través do proceso descrito anteriormente, pode organizar o almacenamento de case calquera información. A beleza do enfoque é que é universal: unha vez que os usuarios se acostuman a el, deixan de facer un lío. Tamén unha gran vantaxe (pero non gratuíta) é a posibilidade de recoller varias estatísticas sobre a marcha e debuxar fermosos diagramas nel.
Vou poñer un exemplo do noso proceso de mantemento da información sobre o equipo.
Para cada persoa do equipo, decidimos crear unha tarxeta de empregado. En consecuencia, temos un modelo segundo o cal cada nova persoa crea esta tarxeta por si mesma e garda nela toda a súa información persoal.
Como podes ver, temos unha táboa detallada de propiedades e inmediatamente temos instrucións sobre como manter esta páxina. Algunhas das etiquetas son colocadas polos propios empregados segundo as instrucións, no modelo só as principais: a etiqueta da tarxeta tarxeta de empregado, etiqueta de dirección dirección-implicación e etiqueta de comando equipo-qa.
Como resultado, despois de que todos crearon unha tarxeta para si mesmos, obtense unha táboa completa con información sobre os empregados. Esta información pódese utilizar en diferentes puntos. Os xestores de recursos poden recoller táboas xerais por si mesmos, e os xefes de equipo poden recoller táboas de comandos engadindo unha etiqueta de equipo á selección.
Por etiquetas, podes ver diferentes resumos, por exemplo, por qa-plan-upgrade mostraranse todas as tarefas para o desenvolvemento do control de calidade. Ao mesmo tempo, cada persoa na súa tarxeta de empregado garda unha historia importante e o seu propio plan de desenvolvemento: crea unha páxina aniñada a partir do modelo de plans de desenvolvemento.
Conclusión
Manteña calquera documentación de forma que non teña vergoña dela e que os usuarios non resulten terriblemente feridos.
Espero de verdade que o artigo sexa útil e que a orde veña en toda a documentación do mundo.
Fonte: www.habr.com