Hola a tots!
Em dic Masha, treballo com a enginyer de garantia de qualitat al grup d'empreses Tinkoff. El treball de control de qualitat implica molta comunicació amb diferents persones de diferents equips, i també vaig ser gestor i professor de programes educatius, així que el meu mapa de comunicació era el més ampli possible. I en algun moment vaig explotar: em vaig adonar que ja no puc, no puc, no puc omplir tones infernals de taules i documents il·legibles.
Segur que ara cadascú de vosaltres s'ha imaginat del que us parlo, i es va suar fredament: llistes de cognoms sense ordre alfabètic, taules amb centenars de columnes amb una disposició descuidada, taules amb milers de línies en què cal esborrar el dit. a la roda del ratolí per mirar l'encapçalament, tones de pàgines d'instruccions sense numerar, centenars de cartes que s'envien entre elles amb dades que cal analitzar i sistematitzar i introduir-les en les mateixes taules il·legibles.
I així, quan em vaig refredar una mica, vaig decidir escriure aquest article. Parlaré de com podeu mantenir normalment (fins i tot de vegades convenientment) una varietat de documentació no relacionada amb el producte. Espero que l'article s'escampi per la xarxa i que el nivell d'infern als departaments adjacents al desenvolupament baixi almenys una mica i la gent (inclòs jo) serà una mica més feliç.
Instruments
La documentació del producte sovint es guarda al costat del codi, la qual cosa és una bona cosa. I la documentació no relacionada amb el producte normalment s'emmagatzema a qualsevol lloc. Sovint, la gent intenta portar informació de diferents llocs a Confluence, i no som una excepció. Així que la resta de la història tracta sobre ell.
En general, Confluence és un motor wiki avançat. Permet treballar amb dades en diferents tipus de visualització: text amb format, taules, gràfics diversos. Aquesta és una eina molt interessant i potent, però si no sabeu com cuinar-la, obtindreu un altre abocador de documents il·legibles. T'ensenyaré a cuinar!
macros
Gairebé tota la màgia de Confluence es construeix al voltant de macros. Hi ha moltes macros i es poden combinar entre elles. Són de pagament i gratuïts, a més hi haurà diversos exemples de macros amb enllaços a la documentació per a elles.
La interfície per treballar amb macros és el més senzilla possible. Per afegir una macro, heu de fer clic al més i seleccionar l'element desitjat de la llista.
Si la macro és autosuficient, és a dir, no requereix la inserció d'una altra cosa dins de si mateixa, sembla un bloc.
Si una macro necessita alguna cosa dins per funcionar, sembla una caixa.
Al mateix temps, pots posar-ne tants com vulguis dins d'un marc, sempre que hi hagi lògica a la teva piràmide.
Cada macro té una vista prèvia: mostra immediatament si heu emplenat i configurat correctament la macro.
plantilles
A més de les macros, hi ha una eina convenient per emplenar el contingut prèviament: aquesta és una plantilla.
Les plantilles es poden utilitzar en crear qualsevol pàgina: només cal que feu clic als tres punts al costat del botó "Crea" i seleccioneu la plantilla desitjada.
A continuació, tot el contingut que hi ha a la plantilla s'afegirà a la pàgina creada.
Qualsevol pot crear pàgines a partir de plantilles, però només els que tenen els drets per crear o editar plantilles ells mateixos poden crear pàgines. Podeu afegir instruccions addicionals a la plantilla sobre com s'ha de mantenir la pàgina.
Màgia de taula
De fet, com a tècnic, m'encanten molt les taules i hi puc incloure gairebé qualsevol informació (tot i que això no sempre és efectiu). Les taules en si són clares, estructurades, escalables, màgiques!
Però fins i tot una entitat tan meravellosa com una taula es pot espatllar. I es pot utilitzar amb èxit i fins i tot millorar. Més sobre això a continuació.
Filtrat (connector de pagament)
Qualsevol taula il·legible enorme es pot fer una mica menys gran i una mica més llegible mitjançant el filtratge. Per fer-ho, podeu utilitzar una macro de pagament .
Dins d'aquesta macro, cal empènyer una taula (fins i tot la més lleig possible, el més important és empènyer-la completament). A la macro, podeu seleccionar columnes per al filtre desplegable, el filtre de text, el filtre numèric i el filtre de data.
Imagineu-vos que tota la informació dels candidats per a totes les vacants està registrada en una llista tabular. Naturalment, sense classificar: la gent no acudeix a les entrevistes per ordre alfabètic. I heu d'entendre si abans heu entrevistat un sol·licitant específic. Només heu de posar aquest infern en una macro de filtre, afegir un filtre de text pel cognom, i voilà, la informació està a la vostra pantalla.
Val la pena assenyalar que filtrar taules enormes pot afectar el rendiment del sistema i el temps de càrrega de la pàgina, de manera que posar una taula enorme al filtre és una crossa temporal, és millor crear un procés en el qual la gent no hagi de crear taules il·legibles enormes (un un exemple del procés es trobarà al final de l'article).
Classificació (connector de pagament)
Amb Magic Macro també podeu establir l'ordenació predeterminada a qualsevol columna i numerar les files. O feu clic a qualsevol columna de la taula posada a la macro de filtre i es produirà l'ordenació per aquesta columna.
Per exemple, tens la mateixa taula amb els sol·licitants i has d'esbrinar quantes entrevistes s'han fet en un mes determinat: ordena per data i alegra't.
Taules dinàmiques (connector de pagament)
Ara passem a un cas més interessant. Imagineu que la vostra taula és enorme i heu de calcular-hi alguna cosa. Per descomptat, podeu copiar-lo a Excel, calcular el que necessiteu i tornar a carregar les dades a Confluence. Es pot aplicar una macro una vegada? i obteniu el mateix resultat, només actualitzat.
Per exemple: teniu una taula que conté les dades de tots els empleats: on es troben geogràficament i quins càrrecs ocupen. Per calcular quantes persones hi ha a cada ciutat, cal seleccionar a la macro "Taula dinàmica" la fila per la qual s'agreguen les dades (ubicació) i el tipus d'operació (addició).
Naturalment, pots agrupar-te segons diversos criteris alhora, pots veure totes les possibilitats .
Gràfics (connector de pagament)
Com he dit, no tothom estime les taules tant com jo. Malauradament, a la majoria dels directius no els agraden gens. Però a tothom li agraden les cartes de colors brillants.
Els creadors de Confluence, sens dubte, ho sabien (de ben segur que també tenen caps als quals els encanten els reportatges i els gràfics, on serien sense això). Per tant, podeu utilitzar la macro màgica . En aquesta macro, heu de posar la taula dinàmica del paràgraf anterior i voilà: les vostres dades grises avorrides es visualitzen molt bé.
Naturalment, aquesta macro també té paràmetres. Es pot trobar un enllaç a la documentació de qualsevol macro al mode d'edició d'aquesta macro.
Facilitat d'agregació
La informació dels paràgrafs anteriors probablement no va ser una revelació per a vostè. Però ara definitivament sabeu com utilitzar les macros, i puc passar a la part més interessant de l'article.
Etiquetes
És dolent quan la gent emmagatzema informació en un article no estructurat o en una taula enorme. Encara pitjor és quan parts d'aquesta informació no només són il·legibles, sinó que també es troben disperses per les extensions de Confluence. Afortunadament, és possible recollir informació dispersa en un sol lloc. Per a això cal utilitzar (etiquetes familiars per a tothom a les xarxes socials).
Es pot afegir qualsevol nombre d'etiquetes a qualsevol pàgina. Si feu clic a una etiqueta, us portarà a una pàgina d'agregació amb enllaços a tot el contingut amb aquesta etiqueta, així com a un conjunt d'etiquetes relacionades. Les etiquetes relacionades són les que apareixen amb freqüència a la mateixa pàgina.
Propietats de la pàgina
Podeu afegir una altra macro interessant a la pàgina per estructurar la informació: . Al seu interior, cal presentar una taula de dues columnes, la primera serà la clau, i la segona serà el valor de la propietat. A més, la macro es pot amagar de la pàgina perquè no interfereixi amb la lectura del contingut, però la pàgina encara estarà marcada amb les claus necessàries.
Fixeu-vos en l'identificador: és convenient configurar-lo per penjar diferents grups de propietats a diferents pàgines (o fins i tot diferents grups de propietats en una pàgina).
informes
Per etiquetes, podeu recollir informes. Per exemple, macro recull totes les pàgines amb un determinat conjunt d'etiquetes.
Però un informe més interessant és una macro . També recull totes les pàgines amb un determinat conjunt d'etiquetes, però no només les enumera, sinó que compila una taula (capteu la connexió amb l'inici de l'article?), en la qual les columnes són les claus de les propietats de la pàgina.
En resulta una taula resum d'informació de diferents fonts. És bo que tingui funcions convenients: disseny adaptatiu, classificació per qualsevol columna. A més, aquesta taula d'informes es pot configurar dins de la macro.
Durant la configuració, podeu eliminar algunes columnes de l'informe, establir l'estat predeterminat o el nombre de registres que es mostren. També podeu configurar l'ID de propietat de la pàgina per veure només la informació que necessiteu.
Per exemple, tens moltes pàgines d'empleats, aquestes pàgines tenen un conjunt de propietats sobre una persona: quin nivell és, on és, quan es va unir a l'equip, etc. Aquestes propietats estan marcades id = inf_empleat. I hi ha un segon conjunt de propietats a la mateixa pàgina, que conté informació sobre una persona com a part d'un equip: quin paper fa la persona, en quin equip està, etc. Aquestes propietats estan marcades ID = team_inf. Aleshores, quan compileu un informe, només podeu mostrar la informació d'un identificador o dos alhora, el que sigui més convenient.
La bellesa d'aquest enfocament és que tothom pot recollir la taula d'informació que necessita, que no duplicarà res i s'actualitzarà quan s'actualitzi la pàgina principal. Per exemple: a un líder d'equip no li importa quan els seus desenvolupadors van obtenir feina, però és important quin paper juga cadascun d'ells a l'equip. El cap de l'equip recollirà un informe sobre l'equip. I al comptable no li importa qui exerceix quin paper, però les posicions són importants: recopilarà un informe sobre les posicions. En aquest cas, la font d'informació no es duplicarà ni es transferirà.
Procés final
Instrucció
Per tant, podem estructurar i agregar informació de manera eficaç a Confluence utilitzant macros com a exemple. Però, idealment, cal assegurar-se que la nova informació s'estructura immediatament i s'incorpora a tots els mecanismes d'agregació que ja estan en ús.
Aquí un munt de macros i plantilles vindran al rescat. Per aconseguir que la gent creï pàgines noves amb el format adequat, podeu utilitzar la macro Crea des de plantilla. Afegeix un botó a la pàgina, fent clic a la qual es crea una pàgina nova a partir de la plantilla que necessiteu. D'aquesta manera obligues la gent a treballar immediatament en el format que necessites.
A la plantilla des de la qual permet crear una pàgina, cal afegir etiquetes, la macro "Propietats de la pàgina" i una taula de les propietats que necessiteu per endavant. També recomano afegir instruccions sobre quins valors cal omplir la pàgina i els valors de les propietats.
Aleshores, el procés final serà així:
- Esteu creant una plantilla per a un tipus d'informació específic.
- En aquesta plantilla, afegiu etiquetes i propietats de pàgina en una macro.
- En qualsevol lloc convenient, creeu una pàgina arrel amb un botó, fent clic a quina pàgina secundària es crea a partir de la plantilla.
- Inicieu-vos a la pàgina arrel dels usuaris que potencialment generaran la informació necessària (segons la plantilla desitjada, fent clic al botó).
- Recolliu un informe sobre les propietats de la pàgina mitjançant les etiquetes que heu especificat a la plantilla.
- Alegra't: tens tota la informació que necessites en un format convenient.
Trampes
Com a enginyer de qualitat, puc dir amb seguretat que no hi ha res perfecte al món. Fins i tot les taules divines són imperfectes. I hi ha inconvenients en el procés anterior.
- Si decidiu canviar els noms o la composició de les propietats de la pàgina, haureu d'actualitzar tots els objectes ja creats perquè les seves dades s'incorporin correctament a l'informe de resum. Això és trist, però d'altra banda, t'obliga a pensar amb detall sobre l'"arquitectura" del teu conjunt d'informació, que és una tasca molt interessant.
- Haureu d'escriure una quantitat decent d'instruccions sobre com omplir les taules d'informació i utilitzar les etiquetes. Però, d'altra banda, només podeu llançar aquest article a totes les persones adequades.
Un exemple d'emmagatzematge de documentació no relacionada amb el producte
Mitjançant el procés descrit anteriorment, podeu organitzar l'emmagatzematge de gairebé qualsevol informació. La bellesa de l'enfocament és que és universal: un cop els usuaris s'hi acostumen, deixen de fer un embolic. També un gran avantatge (però no gratuït) és la possibilitat de recopilar diverses estadístiques sobre la marxa i dibuixar-hi bells diagrames.
Posaré un exemple del nostre procés de manteniment de la informació sobre l'equip.
Per a cada persona de l'equip, vam decidir crear una targeta d'empleat. En conseqüència, disposem d'una plantilla segons la qual cada persona nova crea aquesta targeta per si mateixa i hi guarda tota la seva informació personal.
Com podeu veure, disposem d'una taula detallada de propietats i de seguida tenim instruccions sobre com mantenir aquesta pàgina. Algunes de les etiquetes les posen els mateixos empleats segons les instruccions, a la plantilla només les principals: l'etiqueta de la targeta carnet d'empleat, etiqueta de direcció direcció-implicar i etiqueta de comanda equip-qa.
Com a resultat, després que cadascú hagi creat una targeta per a si mateix, s'obté una taula completa amb informació sobre els empleats. Aquesta informació es pot utilitzar en diferents punts. Els gestors de recursos poden recopilar taules generals per ells mateixos i els líders d'equip poden recopilar taules d'ordres afegint una etiqueta d'equip a la selecció.
Per etiquetes, podeu veure diferents resums, per exemple, per pla d'actualització qa es mostraran totes les tasques per al desenvolupament del control de qualitat. Al mateix temps, cada persona de la seva targeta d'empleat guarda una història important i el seu propi pla de desenvolupament: crea una pàgina imbricada a partir de la plantilla de plans de desenvolupament.
Conclusió
Conserveu qualsevol documentació de manera que no us faci vergonya i els usuaris no es facin greument ferits!
Realment espero que l'article sigui útil i l'ordre vingui a tota la documentació del món.
Font: www.habr.com