Hej alla!
Jag heter Masha, jag arbetar som kvalitetssäkringsingenjör i Tinkoff-gruppen. QA-arbete innebär mycket kommunikation med olika personer från olika team, och jag var även chef och föreläsare på utbildningsprogram, så min kommunikationskarta var så bred som möjligt. Och vid något tillfälle exploderade jag: jag insåg att jag inte längre kan, jag kan inte, jag kan inte fylla i jäkla tonvis av oläsliga tabeller och dokument.
Var och en av er föreställde sig nu vad jag pratar om och kallsvettades: listor med efternamn utan alfabetisk ordning, tabeller med hundratals kolumner med slarvig layout, tabeller med tusentals rader där du måste radera fingret på mushjulet för att se rubrik, massor av sidor med onumrerade instruktioner, hundratals brev skickade till varandra med data som måste analyseras och systematiseras och stoppas in i samma oläsbara tabeller.
Och så, när jag svalnade lite, bestämde jag mig för att skriva den här artikeln. Jag kommer att prata om hur du normalt (även ibland bekvämt) kan underhålla en mängd olika icke-produktdokumentation. Jag hoppas att artikeln kommer att spridas över nätverket och att helvetesnivån på avdelningarna i anslutning till utvecklingen kommer att sjunka åtminstone lite, och människor (inklusive jag) kommer att bli lite gladare.
Verktyg
Produktdokumentation hålls ofta tillsammans med kod, vilket är bra. Och icke-produktdokumentation lagras vanligtvis var som helst. Ofta försöker människor ta med information från olika platser till Confluence, och vi är inget undantag. Så resten av historien handlar om honom.
I allmänhet är Confluence en avancerad wikimotor. Det låter dig arbeta med data i olika typer av visning: text med formatering, tabeller, olika diagram. Detta är ett mycket intressant och kraftfullt verktyg, men om du inte vet hur man lagar det, kommer du att få ytterligare en dumpning av oläsbara dokument. Jag ska lära dig att laga mat!
Makron
Nästan all magi med Confluence är uppbyggd kring makron. Det finns många makron, och de kan kombineras med varandra. De är betalda och gratis, vidare kommer det att finnas olika exempel på makron med länkar till dokumentation för dem.
Gränssnittet för att arbeta med makron är så enkelt som möjligt. För att lägga till ett makro måste du klicka på plustecknet och välja önskat element från listan.
Om makrot är självförsörjande, det vill säga att det inte kräver att något annat sätts in i sig själv, det ser ut som ett block.
Om ett makro behöver något inuti det för att fungera ser det ut som en låda.
Samtidigt kan du sätta så många andra som du vill inom en ram, så länge det finns logik i din pyramid.
Varje makro har en förhandsgranskning: den visar omedelbart om du har fyllt i och konfigurerat makrot korrekt.
mallar
Förutom makron finns det ett bekvämt verktyg för att förfylla innehåll - det här är en mall.
Mallar kan användas när du skapar vilken sida som helst: klicka bara på de tre prickarna bredvid knappen "Skapa" och välj önskad mall.
Då kommer allt innehåll som finns i mallen att läggas till på den skapade sidan.
Vem som helst kan skapa sidor från mallar, men bara de som har rättigheterna att själva skapa eller redigera mallar kan skapa sidor. Du kan lägga till ytterligare instruktioner i mallen om hur sidan ska underhållas.
Bordsmagi
Som tekniker älskar jag faktiskt tabeller och kan lägga in nästan all information i dem (även om det inte alltid är effektivt). Borden i sig är tydliga, strukturerade, skalbara, magiska!
Men även en sådan underbar enhet som ett bord kan bli bortskämd. Och det kan framgångsrikt användas och till och med förbättras. Mer om det nedan.
Filtrering (betald plugin)
Alla stora oläsbara tabeller kan göras lite mindre enorma och lite mer läsbara med hjälp av filtrering. För att göra detta kan du använda ett betalt makro .
Inuti det här makrot måste du skjuta ett bord (även det fulaste är möjligt, det viktigaste är att skjuta det helt). I makrot kan du välja kolumner för rullgardinsfilter, textfilter, numeriskt och datumfilter.
Tänk dig bara att all information om kandidater för alla lediga tjänster registreras i en tabellform. Naturligtvis osorterat - folk kommer inte till intervjuer i alfabetisk ordning. Och du måste förstå om du har intervjuat en specifik sökande tidigare. Du behöver bara lägga det här helvetet i ett filtermakro, lägga till ett textfilter efter efternamn - och voila, informationen finns på din skärm.
Det är värt att notera att filtrering av stora tabeller kan påverka systemets prestanda och sidladdningstid, så att sätta en stor tabell i filtret är en tillfällig krycka, det är bättre att bygga en process där människor inte behöver skapa enorma oläsbara tabeller (en exempel på processen finns i slutet av artikeln).
Sortering (betald plugin)
Med Magic Macro Du kan också ställa in standardsortering på valfri kolumn och numrera raderna. Eller klicka på valfri kolumn i tabellen som lagts in i filtermakrot, och sortering efter denna kolumn kommer att ske.
Du har till exempel samma tabell med sökande och du behöver räkna ut hur många intervjuer som hölls under en viss månad – sortera efter datum och glädjas.
Pivottabeller (betald plugin)
Låt oss nu gå vidare till ett mer intressant fall. Föreställ dig att ditt bord är enormt och du behöver räkna ut något på det. Naturligtvis kan du kopiera det till Excel, beräkna vad du behöver och ladda upp data tillbaka till Confluence. Kan du använda ett makro en gång? och få samma resultat, bara uppdaterad.
Till exempel: du har en tabell som innehåller alla anställdas data – var de befinner sig geografiskt och vilka befattningar de innehar. För att beräkna hur många personer som finns i varje stad måste du i makrot "Pivottabell" välja den rad som data aggregeras efter (plats) och typen av operation (tillägg).
Naturligtvis kan du gruppera efter flera kriterier samtidigt, du kan se alla möjligheter .
Diagram (betald plugin)
Alla älskar som sagt inte bord lika mycket som jag. Tyvärr gillar de flesta chefer dem inte alls. Men alla älskar ljusa färgdiagram.
Skaparna av Confluence visste säkert om detta (de har säkert också chefer som älskar rapporter och diagram, var skulle de vara utan det). Därför kan du använda det magiska makrot . I det här makrot måste du lägga in pivottabellen från föregående stycke, och voila - dina tråkiga grå data är vackert visualiserade.
Naturligtvis har detta makro också inställningar. En länk till dokumentationen för vilket makro som helst finns i redigeringsläget för det makrot.
Enkel aggregering
Informationen från de föregående styckena var förmodligen inte en uppenbarelse för dig. Men nu vet du definitivt hur man använder makron, och jag kan gå vidare till den mer intressanta delen av artikeln.
Tags
Det är dåligt när människor lagrar information i en ostrukturerad artikel eller en enorm tabell. Ännu värre är när delar av denna information inte bara är oläslig, utan också spridd över Confluences vidder. Som tur är går det att samla spridd information på ett ställe. För detta måste du använda (taggar bekanta för alla på sociala nätverk).
Valfritt antal taggar kan läggas till på vilken sida som helst. Genom att klicka på en tagg kommer du till en sammanställningssida med länkar till allt innehåll med den taggen, såväl som en uppsättning relaterade taggar. Relaterade taggar är de som ofta visas på samma sida.
Sidegenskaper
Du kan lägga till ytterligare ett intressant makro på sidan för struktureringsinformation - . Inuti den måste du skicka in en tabell med två kolumner, den första kommer att vara nyckeln och den andra kommer att vara värdet på fastigheten. Dessutom kan makrot döljas från sidan så att det inte stör läsningen av innehållet, men sidan kommer fortfarande att markeras med de nödvändiga nycklarna.
Var uppmärksam på ID - det är bekvämt att ställa in det för att hänga olika grupper av fastigheter på olika sidor (eller till och med olika grupper av fastigheter på en sida).
rapporter
Med taggar kan du samla rapporter. Till exempel makro samlar alla sidor med en viss uppsättning taggar.
Men en mer intressant rapport är ett makro . Den samlar också alla sidor med en viss uppsättning taggar, men listar dem inte bara, utan sammanställer en tabell (fångar du sambandet med början av artikeln?), där kolumnerna är nycklarna till sidegenskaperna.
Det visar sig en sammanfattande tabell med information från olika källor. Det är trevligt att det har praktiska funktioner: adaptiv layout, sortering efter valfri kolumn. En sådan rapporttabell kan också konfigureras inuti makrot.
När du konfigurerar kan du ta bort några kolumner från rapporten, ställa in standardstatus eller antalet visade poster. Du kan också ställa in sidegendoms-ID för att bara se den information du behöver.
Till exempel har du många medarbetarsidor, dessa sidor har en uppsättning egenskaper om en person: vilken nivå han är, var han är, när han gick med i teamet och så vidare. Dessa egenskaper är markerade id = anställd_info. Och det finns en andra uppsättning egenskaper på samma sida, som innehåller information om en person som en del av ett team: vilken roll personen utför, vilket team han är i och så vidare. Dessa egenskaper är markerade ID = team_inf. När du sedan sammanställer en rapport kan du endast visa information för ett ID eller två samtidigt - beroende på vilket som är bekvämast.
Det fina med detta tillvägagångssätt är att alla kan samla informationstabellen de behöver, som inte kommer att duplicera någonting och kommer att uppdateras när huvudsidan uppdateras. Till exempel: en teamledare bryr sig inte om när hans utvecklare fick jobb, men det är viktigt vilken roll var och en av dem spelar i teamet. Teamledaren kommer att samla in en rapport om laget. Och revisorn bryr sig inte om vem som utför vilken roll, men positionerna är viktiga - han kommer att samla in en rapport om positionerna. I det här fallet kommer informationskällan inte att dupliceras eller överföras.
Slutlig process
Instruktion
Så vi kan strukturera och effektivt aggregera information i Confluence med hjälp av makron som exempel. Men helst måste du se till att ny information omedelbart struktureras och kommer in i alla aggregeringsmekanismer som redan används.
Här kommer ett gäng makron och mallar till undsättning. För att få folk att skapa nya sidor i rätt format kan du använda makrot Skapa från mall. Den lägger till en knapp på sidan, genom att klicka på vilken en ny sida skapas från mallen du behöver. På så sätt tvingar du människor att omedelbart arbeta i det format du behöver.
I mallen som du tillåter att skapa en sida från måste du lägga till etiketter, makrot "Sidegenskaper" och en tabell över de egenskaper du behöver i förväg. Jag rekommenderar också att du lägger till instruktioner om vilka värden du ska fylla sidan med och egenskapsvärden.
Sedan kommer den slutliga processen att se ut så här:
- Du skapar en mall för en specifik typ av information.
- Lägg till etiketter och sidegenskaper i ett makro i den här mallen.
- På vilken lämplig plats som helst, skapa en rotsida med en knapp, genom att klicka på vilken en underordnad sida skapas från mallen.
- Starta på rotsidan för användare som potentiellt kommer att generera nödvändig information (enligt önskad mall, genom att klicka på knappen).
- Samla själv en rapport om egenskaperna för sidan genom taggarna som du angav i mallen.
- Gläd dig: du har all information du behöver i ett bekvämt format.
Fallgropar
Som kvalitetsingenjör kan jag lugnt säga att det inte finns något perfekt i världen. Även gudomliga bord är ofullkomliga. Och det finns fallgropar i processen ovan.
- Om du bestämmer dig för att ändra namn eller sammansättning av sidegenskaperna måste du uppdatera alla redan skapade objekt så att deras data korrekt dras in i sammanfattningsrapporten. Detta är tråkigt, men å andra sidan tvingar det dig att tänka i detalj på "arkitekturen" i din informationsuppsättning, vilket är en mycket intressant uppgift.
- Du kommer att behöva skriva en anständig mängd instruktioner om hur du fyller i informationstabellerna och använder taggarna. Men å andra sidan kan du bara kasta den här artikeln på alla rätt personer.
Ett exempel på lagring av icke-produktdokumentation
Genom processen som beskrivs ovan kan du organisera lagringen av nästan all information. Det fina med tillvägagångssättet är att det är universellt: när användarna har vant sig vid det slutar de att göra en enda röra. Ett stort (men inte gratis) plus är också möjligheten att samla olika statistik i farten och rita vackra diagram på den.
Jag kommer att ge ett exempel på vår process för att upprätthålla information om laget.
För varje person i teamet bestämde vi oss för att skapa ett anställdskort. Följaktligen har vi en mall enligt vilken varje ny person skapar detta kort för sig själv och behåller all sin personliga information i den.
Som du kan se har vi en detaljerad tabell över fastigheter och har omedelbart instruktioner om hur man underhåller denna sida. En del av taggarna sätts ner av de anställda själva enligt instruktionerna, i mallen endast de viktigaste: kortbrickan anställd-kort, riktningsetikett riktning-involvera och kommandotagg team-qa.
Som ett resultat, efter att alla har skapat ett kort för sig själva, erhålls en komplett tabell med information om anställda. Denna information kan användas på olika ställen. Resurshanterare kan samla in allmänna tabeller för sig själva, och gruppledare kan samla in kommandotabeller genom att lägga till en teamtagg i urvalet.
Efter taggar kan du se olika sammanfattningar, till exempel av qa-uppgraderingsplan alla uppgifter för QA-utveckling kommer att visas. Samtidigt behåller varje person på sitt medarbetarkort en viktig historia och sin egen utvecklingsplan - han skapar en kapslad sida från mallen för utvecklingsplaner.
Slutsats
Förvara all dokumentation på ett sådant sätt att du inte skäms för det, och användarna inte skadas ohyggligt!
Jag hoppas verkligen att artikeln kommer att vara användbar och att det kommer ordning på all världens dokumentation.
Källa: will.com