{"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\/sv\/blog\/administrirovanie\/proektirovanie-v-confluence","title":{"rendered":"Design i Confluence","gt_translate_keys":[{"key":"rendered","format":"text"}]},"content":{"rendered":"

Hej alla! <\/p>\n

Jag heter Masha och jag arbetar som kvalitetss\u00e4kringsingenj\u00f6r inom Tinkoff-gruppen. QA-arbetet inneb\u00e4r m\u00e5nga kommunikationer med olika m\u00e4nniskor fr\u00e5n olika team, och jag har dessutom varit projektledare och f\u00f6rel\u00e4sare f\u00f6r utbildningsprogram, s\u00e5 mitt kommunikationsn\u00e4t var s\u00e5 brett som m\u00f6jligt. Och i ett \u00f6gonblick exploderade jag: jag ins\u00e5g att jag inte l\u00e4ngre kunde, inte kunde, inte kunde fylla i ofattbara m\u00e4ngder ol\u00e4sliga tabeller och dokument. <\/p>\n

\"Design
\n
\n<\/a><\/noindex>
\nJag \u00e4r s\u00e4ker p\u00e5 att ni alla nu har f\u00f6rest\u00e4llt er det jag pratar om och svettas kallt: listor med namn utan alfabetisk ordning, tabeller med hundratals kolumner med f\u00f6rskjuten layout, tabeller med tusentals rader d\u00e4r man m\u00e5ste dra sitt finger \u00f6ver musens hjul f\u00f6r att se rubriken, tonvis av sidor med onumrerade instruktioner, hundratals mail som skickas fram och tillbaka med data som m\u00e5ste analyseras och systematiseras f\u00f6r att stoppas in i lika ol\u00e4sliga tabeller.<\/p>\n

\"Design
\n
\nS\u00e5 n\u00e4r jag lugnade ner mig besl\u00f6t jag mig f\u00f6r att skriva den h\u00e4r artikeln. Jag kommer att ber\u00e4tta om hur man p\u00e5 ett ordentligt (ibland till och med bekv\u00e4mt) kan hantera olika typer av icke-produktdokumentation. Jag hoppas att artikeln sprids p\u00e5 n\u00e4tet och att niv\u00e5n av el\u00e4nde i angr\u00e4nsande avdelningar till utvecklingen minskar lite grann, och att m\u00e4nniskor (inklusive jag sj\u00e4lv) blir lite lyckligare.<\/p>\n

\"Design
\n<\/p>\n

Verktyg<\/h2>\n

\nProduktdokumentation lagras ofta n\u00e4ra koden, vilket \u00e4r bra. Men icke-produktdokumentation lagras ofta lite h\u00e4r och d\u00e4r. Ofta f\u00f6rs\u00f6ker folk f\u00f6ra \u00f6ver information fr\u00e5n olika st\u00e4llen till Confluence, och vi g\u00f6r inget undantag. S\u00e5 allt som f\u00f6ljer handlar om det.<\/p>\n

Confluence \u00e4r i grunden en avancerad wiki-motor. Den m\u00f6jligg\u00f6r arbete med data i olika visningsformer: text med formatering, tabeller, olika diagram. Det \u00e4r ett mycket intressant och kraftfullt verktyg, men om man inte vet hur man f\u00f6rbereder det, f\u00e5r man bara en ny avstj\u00e4lpningsplats f\u00f6r ol\u00e4sliga dokument. Jag ska l\u00e4ra er att f\u00f6rbereda det!<\/p>\n

\"Design
\n<\/p>\n

Makron<\/h2>\n

\nN\u00e4stan all magi i Confluence bygger p\u00e5 makron. Det finns m\u00e5nga makron och de kan kombineras med varandra. De \u00e4r b\u00e5de betal- och gratisversioner, nedan kommer olika exempel p\u00e5 makron med l\u00e4nkar till dokumentation f\u00f6r dem.<\/p>\n

Gr\u00e4nssnittet f\u00f6r att arbeta med makron \u00e4r mycket enkelt. F\u00f6r att l\u00e4gga till ett makro, tryck p\u00e5 pluset och v\u00e4lj det element du beh\u00f6ver fr\u00e5n listan.<\/p>\n

\"Design
\n
\nOm makrot \u00e4r sj\u00e4lvf\u00f6rs\u00f6rjande, det vill s\u00e4ga inte kr\u00e4ver att n\u00e5got annat s\u00e4tts in i sig sj\u00e4lvt, ser det ut som en block.<\/p>\n

\"Design
\n
\nOm makret beh\u00f6ver n\u00e5got f\u00f6r att fungera, ser det ut som en ram.<\/p>\n

\"Design
\n
\nInom samma ram kan man placera s\u00e5 m\u00e5nga andra som helst, s\u00e5 l\u00e4nge det finns logik i din pyramide.<\/p>\n

\"Design
\n
\nVarje makro har en f\u00f6rhandsvisning: h\u00e4r kan man direkt se om du har fyllt i och st\u00e4llt in makrot korrekt.<\/p>\n

Mallar<\/h2>\n

\nUt\u00f6ver makron finns det ett praktiskt verktyg f\u00f6r f\u00f6rhandsifyllning av inneh\u00e5ll \u2013 det \u00e4r en mall.
\nMallar kan anv\u00e4ndas n\u00e4r du skapar vilken sida som helst: tryck bara p\u00e5 de tre punkterna bredvid knappen \"Skapa\" och v\u00e4lj den mall du beh\u00f6ver.<\/p>\n

\"Design
\n
\nD\u00e5 l\u00e4ggs allt inneh\u00e5ll fr\u00e5n mallen till i den skapade sidan.<\/p>\n

Att skapa sidor fr\u00e5n mallar kan vem som helst g\u00f6ra, men att skapa eller redigera sj\u00e4lva mallarna f\u00e5r endast de som har r\u00e4tt till det. En mall kan \u00e4ven kompletteras med ytterligare instruktioner om hur sidan b\u00f6r underh\u00e5llas.<\/p>\n

\"Design
\n<\/p>\n

Magin i tabeller<\/h2>\n

\nEgentligen tycker jag, som tekniker, mycket om tabeller och kan n\u00e4stan alltid v\u00e4nda information i dem (\u00e4ven om det inte alltid \u00e4r effektivt). Sj\u00e4lva tabellerna \u00e4r tydliga, strukturerade, skalbara, magiska!<\/p>\n

\"Design
\n
\nMen \u00e4ven en s\u00e5 fantastisk entitet som en tabell kan f\u00f6rst\u00f6ras. Det g\u00e5r ocks\u00e5 att anv\u00e4nda dem p\u00e5 ett lyckat s\u00e4tt och till och med f\u00f6rb\u00e4ttra dem. Mer om detta nedan.<\/p>\n

Filtrering (betald plugin)<\/h3>\n

\nVilken stor, ol\u00e4slig tabell som helst kan g\u00f6ras lite mindre stor och lite mer l\u00e4sbar med hj\u00e4lp av filtrering. F\u00f6r detta kan du anv\u00e4nda ett betalt makro. \u00abTabellfilter\u00bb<\/a><\/noindex>.<\/p>\n

Inuti detta makro m\u00e5ste en tabell s\u00e4ttas in (\u00e4ven den fulaste, det viktigaste \u00e4r att f\u00e5 in den helt). I makrot kan du v\u00e4lja kolumner f\u00f6r filtrering med en rullgardinsmeny, textfilter, numeriska filter och datumfilter. <\/p>\n

\"Design
\n
\nT\u00e4nk dig att all information om kandidater f\u00f6r alla lediga tj\u00e4nster skrivs in i en tabell. Naturligtvis osorterad \u2013 folk kommer ju inte till intervju i alfabetisk ordning. Och du m\u00e5ste f\u00f6rst\u00e5 om du har intervjuat en specifik kandidat tidigare. Du m\u00e5ste bara stoppa denna mardr\u00f6m i filtreringsmakrot, l\u00e4gga till ett textfilter p\u00e5 efternamn \u2013 och voila, informationen \u00e4r p\u00e5 sk\u00e4rmen.<\/p>\n

\"Design
\n
\nDet \u00e4r v\u00e4rt att notera att filtrering av stora tabeller kan p\u00e5verka systemets prestanda och sidladdningstid, s\u00e5 att placera en stor tabell i ett filter \u00e4r en tillf\u00e4llig l\u00f6sning, det \u00e4r b\u00e4ttre att bygga en process d\u00e4r folk inte beh\u00f6ver skapa stora, ol\u00e4sliga tabeller (ett exempel p\u00e5 processen kommer i slutet av artikeln).<\/p>\n

Sortering (betald plugin)<\/h3>\n

\nMed hj\u00e4lp av den magiska makron \u00abTabellfilter\u00bb<\/a><\/noindex> kan man ocks\u00e5 ange standard sortering f\u00f6r valfri kolumn och numrera rader. Eller s\u00e5 kan man klicka p\u00e5 vilken kolumn i tabellen som helst som har placerats i filtermakrot, och sortering kommer att ske efter den kolumnen. <\/p>\n

\"Design
\n
\nTill exempel, om du har samma tabell med kandidater och beh\u00f6ver uppskatta hur m\u00e5nga intervjuer som genomf\u00f6rdes under en viss m\u00e5nad, - sortera efter datum och njut.<\/p>\n

Pivottabeller (betald plugin)<\/h3>\n

\nNu g\u00e5r vi till ett intressantare fall. T\u00e4nk dig att din tabell \u00e4r j\u00e4ttestor och du beh\u00f6ver r\u00e4kna n\u00e5got p\u00e5 den. Naturligtvis kan du kopiera den till Excel, r\u00e4kna vad du beh\u00f6ver och ladda upp data tillbaka till Confluence. Men du kan ocks\u00e5 en g\u00e5ng till\u00e4mpa makrot \u00abPivottabell\u00bb<\/a><\/noindex> och f\u00e5 samma resultat, bara att det ocks\u00e5 uppdateras.<\/p>\n

Till exempel: om du har en tabell som samlar data om alla anst\u00e4llda - var de geografiskt befinner sig och vilken position de har. F\u00f6r att r\u00e4kna hur m\u00e5nga personer som finns i varje stad, beh\u00f6ver du v\u00e4lja i makrot \u00abPivottabell\u00bb den rad efter vilken data aggregeras (plats) och typ av operation (addition).<\/p>\n

\"Design
\n
\nSj\u00e4lvklart kan du gruppera efter flera kriterier samtidigt, alla m\u00f6jligheter kan du se i dokumentationen<\/a><\/noindex>.<\/p>\n

Diagram (betald plugin)<\/h3>\n

\nSom jag redan n\u00e4mnt, \u00e4lskar inte alla tabeller lika mycket som jag g\u00f6r. Tyv\u00e4rr gillar de flesta chefer dem \u00f6verhuvudtaget inte. Men alla \u00e4lskar verkligen f\u00e4rgglada diagram.
\nSkapararna av Confluence visste s\u00e4kert detta (de har s\u00e4kert ocks\u00e5 en chef som \u00e4lskar rapporter och diagram, hur skulle det annars vara). S\u00e5 du kan anv\u00e4nda den magiska makron \u00abDiagram fr\u00e5n tabell\u00bb<\/a><\/noindex>. I denna makro beh\u00f6ver du placera pivottabellen fr\u00e5n f\u00f6reg\u00e5ende punkt, och vips - dina gr\u00e5 tr\u00e5kiga data \u00e4r vackert visualiserade.<\/p>\n

\"Design
\n
\nSj\u00e4lvklart finns det ocks\u00e5 inst\u00e4llningar i denna makro. L\u00e4nken till dokumentationen f\u00f6r vilket makro som helst kan du hitta i redigeringsl\u00e4get f\u00f6r denna makro.<\/p>\n

Enkelhet i aggregering<\/h2>\n

\nInformation from the previous points was probably not a revelation for you. But now you certainly know how to use macros, and I can move on to a more interesting part of the article.<\/p>\n

\"Design
\n<\/p>\n

Taggar<\/h3>\n

\nIt's poor practice when people store information in one unstructured article or a huge spreadsheet. Even worse is when parts of this information are not only poorly formatted but also scattered across the expanses of Confluence. Fortunately, there's a way to gather scattered information in one place. For this, you need to use taggar<\/a><\/noindex> (familiar to everyone from social media tags).<\/p>\n

\"Design
\n
\nYou can add any number of tags to any page. If you click on a tag, you'll be taken to an aggregation page that contains links to all materials with that tag, as well as a set of related tags. Related tags are those that often appear on the same page.<\/p>\n

\"Design
\n<\/p>\n

Sidproperty<\/h3>\n

\nYou can also add another interesting macro for structuring information to the page \u2014 \u00abSidproperty\u00bb<\/a><\/noindex>. Inside, you need to provide a table with two columns; the first will serve as the key, and the second as the value of the property. Additionally, the macro can be hidden from the page so that it does not interfere with reading the content, but the page will still be marked with the necessary keys.<\/p>\n

\"Design
\n
\nNote the ID \u2014 it's convenient to set it to apply different groups of properties to different pages (or even different groups of properties on one page). <\/p>\n

Rapporter<\/h3>\n

\nYou can collect reports by tags. For example, the macro \u00abInneh\u00e5llsrapport\u00bb<\/a><\/noindex> collects all pages with a specific set of tags.<\/p>\n

\"Design
\n
\nBut a more interesting report is the macro \u00abSidpropertyrapport\u00bb<\/a><\/noindex>. It also collects all pages with a specific set of tags, but instead of simply listing them, it creates a table (catch the connection to the beginning of the article?), where the columns are the keys of the page properties.<\/p>\n

\"Design
\n
\nIt results in a summary table of information from various sources. It's nice that it has useful functions: responsive layout, sorting by any column. This report table can also be configured within the macro. <\/p>\n

\"Design
\n
\nWhen configuring, you can remove certain columns from the report, set the default state, or the number of displayed records. You can also specify the ID of the page property to see only the information you need.<\/p>\n

Till exempel, du har m\u00e5nga anst\u00e4lldasidor, och dessa sidor har en upps\u00e4ttning egenskaper om personen: vilken niv\u00e5 de har, var de befinner sig, n\u00e4r de kom till teamet och s\u00e5 vidare. Dessa egenskaper \u00e4r markerade ID = employee_inf<\/i>. Det finns ocks\u00e5 en andra upps\u00e4ttning egenskaper p\u00e5 samma sida, d\u00e4r informationen om personen som en del av teamet \u00e4r samlad: vilken roll personen har, i vilket team de befinner sig och s\u00e5 vidare. Dessa egenskaper \u00e4r markerade ID = team_inf<\/i>. S\u00e5 n\u00e4r du sammanst\u00e4ller en rapport kan du antingen visa information baserat p\u00e5 ett ID eller p\u00e5 tv\u00e5 \u2014 beroende p\u00e5 vad som \u00e4r bekv\u00e4mare.<\/p>\n

Sk\u00f6nheten med denna metod \u00e4r att varje person kan samla den informationstabell de beh\u00f6ver, som inte duplicerar n\u00e5got och som uppdateras n\u00e4r huvud sidan uppdateras. Till exempel: en teamledare bryr sig inte om n\u00e4r hans utvecklare b\u00f6rjade arbeta, utan om vilken roll var och en av dem har i teamet. Teamledaren kommer att samla sin rapport om teamet. En revisor bryr sig \u00f6verhuvudtaget inte om vilken roll som utf\u00f6rs, men det \u00e4r viktigt med positionerna - han kommer att samla sin rapport om positionerna. Samtidigt kommer informationsk\u00e4llan inte att dupliceras eller flyttas.<\/p>\n

Slutprocessen<\/h2>\n

<\/p>\n

Instruktion<\/h3>\n

\nS\u00e5, vi kan vackert strukturera och effektivt aggregera information i Confluence genom att anv\u00e4nda makron. Men i idealfallet b\u00f6r vi se till att ny information omedelbart \u00e4r strukturerad och kommer in i alla redan anv\u00e4nda aggregationsmekanismer.<\/p>\n

H\u00e4r kommer en kombination av makron och mallar till hj\u00e4lp. F\u00f6r att f\u00e5 m\u00e4nniskor att skapa nya sidor i r\u00e4tt format kan du anv\u00e4nda makrot \"Skapa fr\u00e5n mall\". Det l\u00e4gger till en knapp p\u00e5 sidan, som n\u00e4r man klickar p\u00e5 den skapar en ny sida fr\u00e5n den mall du \u00f6nskar. S\u00e5 du tvingar m\u00e4nniskor att omedelbart arbeta i det format du beh\u00f6ver. <\/p>\n

\"Design
\n
\nI mallen, fr\u00e5n vilken du ger m\u00f6jlighet att skapa en sida, beh\u00f6ver du p\u00e5 f\u00f6rhand l\u00e4gga till etiketter, makrot \"Egenskaper f\u00f6r sidan\" och tabellen med de egenskaper du beh\u00f6ver. Jag rekommenderar ocks\u00e5 att l\u00e4gga till instruktioner om vilka v\u00e4rden som ska fyllas p\u00e5 sidan och v\u00e4rdena f\u00f6r egenskaperna.<\/p>\n

\"Design
\n
\nD\u00e5 kommer slutprocessen att se ut s\u00e5 h\u00e4r:<\/p>\n

    \n
  1. Du skapar en mall f\u00f6r information av viss typ.<\/li>\n
  2. I denna mall l\u00e4gger du till etiketter och sidans egenskaper i makrot.<\/li>\n
  3. P\u00e5 valfri plats skapar du en huvudsida med en knapp, som, n\u00e4r du klickar p\u00e5 den, skapar en undersida utifr\u00e5n en mall. <\/li>\n
  4. Du bjuder in anv\u00e4ndare till huvudsidan som potentiellt kan generera den information som beh\u00f6vs (enligt mallen, genom att klicka p\u00e5 knappen).<\/li>\n
  5. Du samlar en rapport om sidans egenskaper via de etiketter som du angav i mallen.<\/li>\n
  6. Du \u00e4r glad: du har all n\u00f6dv\u00e4ndig information i ett bekv\u00e4mt format. <\/li>\n<\/ol>\n

    \"Design
    \n<\/p>\n

    F\u00e4llor<\/h3>\n

    \nSom kvalitetsingenj\u00f6r kan jag utan tvekan p\u00e5st\u00e5 att inget \u00e4r perfekt i v\u00e4rlden. \u00c4ven gudomliga tabeller \u00e4r inte perfekta. Och i processen som beskrivits ovan finns det f\u00e4llor.<\/p>\n