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

Hallo allemaal! <\/p>\n

Mijn naam is Masha, ik werk als kwaliteitsingenieur bij de Tinkoff-groep. Het werk van QA vereist veel communicatie met verschillende mensen uit verschillende teams, en ik was bovendien manager en docent van educatieve programma's, waardoor mijn communicatienetwerk zo breed mogelijk was. En op een gegeven moment kon ik het niet meer aan: ik besefte dat ik niet langer die afschuwelijke hoeveelheden onleesbare tabellen en documenten kon invullen. <\/p>\n

\"Ontwerp
\n
\n<\/a><\/noindex>
\nVast en zeker heeft iedereen van jullie zichzelf nu datgene voorgesteld waar ik het over heb en heeft het koude zweet op zijn voorhoofd staan: lijsten met achternamen zonder alfabetische volgorde, tabellen met honderden kolommen met een misvormde lay-out, tabellen met duizenden rijen waarin je je vinger over de muis moet wrijven om de koptekst te zien, tonnen pagina's ongeletterde instructies, honderden e-mails die heen en weer worden gestuurd met gegevens die geanalyseerd en gesystematiseerd moeten worden en in dezelfde onleesbare tabellen moeten worden gepropt.<\/p>\n

\"Ontwerp
\n
\nEn toen ik wat afgekoeld was, besloot ik dit artikel te schrijven. Ik zal vertellen hoe je normaal (en soms zelfs handig) verschillende niet-productdocumentatie kunt bijhouden. Ik hoop dat dit artikel zich verspreidt op het web en dat het niveau van ellende in de afdelingen naast ontwikkeling ook maar iets vermindert, en dat mensen (ik maak daar ook een deel van uit) een beetje gelukkiger worden.<\/p>\n

\"Ontwerp
\n<\/p>\n

Hulpmiddelen<\/h2>\n

\nProductdocumentatie wordt vaak naast de code opgeslagen, en dat is goed. Maar niet-productdocumentatie wordt meestal overal opgeslagen. Vaak proberen mensen informatie uit verschillende bronnen naar Confluence te verplaatsen, en wij zijn daar geen uitzondering in. Dus het hele verhaal gaat hier verder over.<\/p>\n

Confluence is eigenlijk een geavanceerde wiki-engine. Het stelt je in staat om met gegevens op verschillende manieren te werken: opgemaakte tekst, tabellen, diverse diagrammen. Dit is een heel interessant en krachtig hulpmiddel, maar als je niet weet hoe je het moet voorbereiden, krijg je een nieuwe stapel onleesbare documenten. Ik ga je leren hoe je het moet voorbereiden!<\/p>\n

\"Ontwerp
\n<\/p>\n

Macros<\/h2>\n

\nBijna al de magie van Confluence is opgebouwd uit macro's. Er zijn veel macro's, en je kunt ze met elkaar combineren. Ze zijn er in gratis en betaalde versies, hieronder zullen verschillende macro-voorbeelden zijn met links naar de documentatie ervan.<\/p>\n

De interface voor het werken met macro's is zo eenvoudig mogelijk. Om een macro toe te voegen, moet je op de plus klikken en het gewenste element uit de lijst kiezen.<\/p>\n

\"Ontwerp
\n
\nAls de macro zelfstandige is, dat wil zeggen, deze vereist geen invoeging van iets anders in zichzelf, ziet deze eruit als een blok.<\/p>\n

\"Ontwerp
\n
\nAls er iets in de macro moet worden geplaatst voor de werking, ziet deze eruit als een kader.<\/p>\n

\"Ontwerp
\n
\nJe kunt in \u00e9\u00e9n kader echter zoveel andere elementen plaatsen als je wilt, zolang er maar logica in je piramide zit.<\/p>\n

\"Ontwerp
\n
\nElke macro heeft een voorbeeldweergave: hierin zie je meteen of je de macro goed hebt ingevuld en ingesteld.<\/p>\n

Sjablonen<\/h2>\n

\nNaast macro's is er een handige tool voor het vooraf invullen van content - dit is een sjabloon.
\nSjablonen kunnen worden gebruikt bij het aanmaken van elke pagina: je hoeft alleen maar op de drie stippen naast de knop 'Maak aan' te klikken en het gewenste sjabloon te selecteren.<\/p>\n

\"Ontwerp
\n
\nDan wordt alle content die in het sjabloon staat aan de aangemaakte pagina toegevoegd.<\/p>\n

Iedereen kan pagina's aanmaken uit sjablonen, maar alleen degenen met de juiste rechten kunnen de sjablonen zelf aanmaken of bewerken. In een sjabloon kunnen aanvullende instructies worden toegevoegd over hoe de pagina moet worden beheerd.<\/p>\n

\"Ontwerp
\n<\/p>\n

De magie van tabellen<\/h2>\n

\nAls techneut ben ik dol op tabellen en kan ik bijna elke informatie daarin verwerken (hoewel dat niet altijd effici\u00ebnt is). Tabellen zijn zelf doorzichtig, gestructureerd, schaalbaar, en magisch!<\/p>\n

\"Ontwerp
\n
\nMaar zelfs zo'n geweldig iets als een tabel kan worden bedorven. Maar als je ze juist gebruikt, kunnen ze zelfs worden verbeterd. Hierover meer hieronder.<\/p>\n

Filtering (betaalde plugin)<\/h3>\n

\nElke enorme, onleesbare tabel kan minder groot en beter leesbaar worden gemaakt door middel van filtering. Hiervoor kan je een betaalde macro gebruiken. \u2018Tabelfilter\u2019<\/a><\/noindex>.<\/p>\n

Je moet de tabel (zelfs de lelijkste) in deze macro stoppen, het belangrijkste is dat je deze volledig erin stopt. In de macro kun je kolommen voor filtering kiezen met een dropdownlijst, tekstfilter, numeriek filter en filter op datums. <\/p>\n

\"Ontwerp
\n
\nStel je voor dat alle informatie over kandidaten voor alle vacatures in een tabelvorm wordt vastgelegd. Natuurlijk niet gesorteerd - mensen komen niet alfabetisch naar sollicitatiegesprekken. En jij moet begrijpen of je al eerder een gesprek met een bepaalde sollicitant hebt gehad. Je moet gewoon die hele chaos in de filtermacro stoppen, een tekstfilter op de achternaam toevoegen - en voil\u00e0, de informatie is op je scherm.<\/p>\n

\"Ontwerp
\n
\nHet is belangrijk op te merken dat het filteren van enorme tabellen de systeemwerking en de laadtijd van pagina's kan be\u00efnvloeden, dus het in een filter stoppen van een enorme tabel is een tijdelijke oplossing. Het is beter om een proces op te zetten waarin mensen geen enorme onleesbare tabellen hoeven te maken (een voorbeeld van dit proces wordt aan het eind van het artikel gegeven).<\/p>\n

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

\nMet behulp van de magische macro \u2018Tabelfilter\u2019<\/a><\/noindex> kan ook een standaard sortering op elke kolom worden ingesteld en de rijen worden genummerd. Of je kunt op elke kolom van de tabel klikken die in de filtermacro is geplaatst, en deze zal op die kolom worden gesorteerd. <\/p>\n

\"Ontwerp
\n
\nBijvoorbeeld, je hebt dezelfde tabel met sollicitanten en je moet inschatten hoeveel gesprekken in een bepaalde maand zijn gevoerd \u2014 sorteer op datum en wees blij.<\/p>\n

Draaitabellen (betaalde plugin)<\/h3>\n

\nLaten we nu over een interessanter geval praten. Stel je voor dat je tabel enorm is en je iets ervoor moet berekenen. Natuurlijk kun je het in Excel kopi\u00ebren, de benodigde berekeningen doen en de gegevens terug in Confluence laden. Maar je kunt ook een keer de macro \u2018Draaitabel\u2019<\/a><\/noindex> toepassen en hetzelfde resultaat krijgen, alleen dan ook automatisch bijgewerkt.<\/p>\n

Bijvoorbeeld: je hebt een tabel met gegevens van alle medewerkers \u2014 waar ze zich geografisch bevinden en welke functies ze bekleden. Om te tellen hoeveel mensen zich in elke stad bevinden, moet je in de macro \u2018Draaitabel\u2019 de rij kiezen waarop de gegevens worden geaggregeerd (locatie) en het type bewerking (optelling).<\/p>\n

\"Ontwerp
\n
\nNatuurlijk kun je op meerdere criteria tegelijk groeperen, alle mogelijkheden kun je bekijken. De volgende interactieve opdracht<\/a><\/noindex>.<\/p>\n

Diagrammen (betaalde plugin)<\/h3>\n

\nZoals ik al zei, houdt niet iedereen evenveel van tabellen als ik. Helaas houden de meeste managers er helemaal niet van. Maar iedereen houdt van heldere, kleurrijke diagrammen.
\nDe makers van Confluence wisten dit zonder twijfel (ze hebben vast ook leidinggevenden die van rapporten en diagrammen houden, dat kan niet anders). Daarom kun je gebruikmaken van de magische macro \u2018Diagram van de tabel\u2019<\/a><\/noindex>. In deze macro moet de draaitabel uit de vorige sectie worden geplaatst, en voil\u00e0 \u2014 je saaie grijze gegevens zijn mooi gevisualiseerd.<\/p>\n

\"Ontwerp
\n
\nNatuurlijk zijn er ook instellingen voor deze macro. De link naar de documentatie voor elke macro kan worden gevonden in de bewerkingsmodus van deze macro.<\/p>\n

Eenvoud van aggregatie<\/h2>\n

\nDe informatie uit de vorige punten was waarschijnlijk geen openbaring voor u. Maar nu weet u zeker hoe u met macro's moet werken, en kan ik verder gaan met het interessantere deel van het artikel.<\/p>\n

\"Ontwerp
\n<\/p>\n

Tags<\/h3>\n

\nHet is vervelend als mensen informatie opslaan in \u00e9\u00e9n ongestructureerd artikel of een enorme tabel. Nog erger is het wanneer delen van deze informatie niet alleen moeilijk leesbaar zijn, maar ook verspreid zijn over de wijdten van Confluence. Gelukkig is er een mogelijkheid om verspreide informatie op \u00e9\u00e9n plek te verzamelen. Hiervoor moet u gebruikmaken van labels<\/a><\/noindex> (bekend van sociale netwerken).<\/p>\n

\"Ontwerp
\n
\nU kunt elk aantal labels aan een pagina toevoegen. Als u op een label klikt, komt u op een aggregatiepagina terecht, waar links staan naar alle materialen met dat label, evenals een set verwante labels. Verwante labels zijn diegene die vaak op dezelfde pagina voorkomen.<\/p>\n

\"Ontwerp
\n<\/p>\n

Pagina-eigenschappen<\/h3>\n

\nU kunt een interessante macro voor het structureren van informatie aan de pagina toevoegen \u2014 \u2018Pagina-eigenschappen\u2019<\/a><\/noindex>. U moet er een tabel met twee kolommen in plaatsen, waarbij de eerste de sleutel is en de tweede de waarde van de eigenschap. De macro kan zelfs onzichtbaar op de pagina worden gemaakt, zodat deze de leesbaarheid van de inhoud niet verstoort, maar de pagina wordt nog steeds gemarkeerd met de benodigde sleutels.<\/p>\n

\"Ontwerp
\n
\nLet op de ID \u2014 deze is handig in te stellen zodat verschillende groepen eigenschappen aan verschillende pagina's (of zelfs verschillende groepen eigenschappen op \u00e9\u00e9n pagina) kunnen worden gekoppeld. <\/p>\n

Rapporten<\/h3>\n

\nOp basis van labels kunnen rapporten worden verzameld. Bijvoorbeeld, de macro \u2018Inhoudsrapport\u2019<\/a><\/noindex> verzamelt alle pagina's met een bepaalde set labels.<\/p>\n

\"Ontwerp
\n
\nMaar een interessanter rapport is de macro \u2018Pagina-eigenschappen rapport\u2019<\/a><\/noindex>. Deze verzamelt ook alle pagina's met een bepaalde set labels, maar geeft niet alleen een lijst weer, maar stelt een tabel op (begrijpt u de link met het begin van het artikel?), waarbij de kolommen de sleutels van de pagina-eigenschappen zijn.<\/p>\n

\"Ontwerp
\n
\nHet resultaat is een samenvattende tabel met informatie uit verschillende bronnen. Fijn is dat het handige functies heeft: responsieve lay-out, sorteren op elke kolom. Ook kan deze rapportagetabel worden geconfigureerd binnen de macro. <\/p>\n

\"Ontwerp
\n
\nBij configuratie kunt u bepaalde kolommen uit het rapport verwijderen, een standaardstatus of het aantal weergegeven records instellen. U kunt ook de ID van de pagina-eigenschap instellen, zodat alleen de benodigde informatie zichtbaar is.<\/p>\n

Bijvoorbeeld, u hebt een aantal medewerkerspagina's, en deze pagina's hebben een set eigenschappen over de persoon: welke niveau hij heeft, waar hij zich bevindt, wanneer hij bij het team kwam, enzovoort. Deze eigenschappen zijn gemarkeerd ID = employee_inf<\/i>. En er is een tweede set eigenschappen op dezelfde pagina, waarin informatie over de persoon is verzameld als onderdeel van het team: welke rol de persoon vervult, in welk team hij zich bevindt, enzovoort. Deze eigenschappen zijn gemarkeerd ID = team_inf<\/i>. Dan kunt u bij het samenstellen van het rapport alleen informatie opgeven voor \u00e9\u00e9n ID of voor beide \u2014 afhankelijk van wat handiger is.<\/p>\n

Het voordeel van deze aanpak is dat iedereen de informatie die hij nodig heeft kan samenstellen in een informatieve tabel, die niets dupliceert en wordt bijgewerkt wanneer de hoofdpagina wordt bijgewerkt. Bijvoorbeeld: een teamleider is niet ge\u00efnteresseerd in wanneer zijn ontwikkelaars zijn begonnen te werken, maar het is belangrijk welke rol ieder van hen vervult in het team. De teamleider stelt een rapport samen over het team. Een boekhouder geeft er eigenlijk niets om wie welke rol vervult, maar de functies zijn belangrijk \u2014 hij stelt een rapport samen over de functies. Ondertussen wordt de informatiebron niet gedupliceerd of verplaatst.<\/p>\n

Eindproces<\/h2>\n

<\/p>\n

Instructie<\/h3>\n

\nDus, we kunnen informatie mooi structureren en effectief aggregeren in Confluence aan de hand van het gebruik van macros. Maar idealiter moet nieuwe informatie meteen gestructureerd zijn en in alle reeds gebruikte aggregatiemechanismen terechtkomen.<\/p>\n

Hier komt de combinatie van macros en sjablonen van pas. Om ervoor te zorgen dat mensen nieuwe pagina's in het juiste formaat maken, kunt u de macro 'Cre\u00eber uit sjabloon' gebruiken. Dit voegt een knop aan de pagina toe, waarop geklikt wordt om een nieuwe pagina aan te maken uit het gewenste sjabloon. Op deze manier dwingt u mensen om meteen te werken in het formaat dat u nodig heeft. <\/p>\n

\"Ontwerp
\n
\nIn het sjabloon, waaruit u een pagina laat aanmaken, moet u van tevoren labels, de macro 'Pagina-eigenschappen' en de benodigde eigenschappenstabel toevoegen. Ook raad ik aan om instructies toe te voegen over welke waarden op de pagina moeten worden ingevuld, en de waarden van de eigenschappen.<\/p>\n

\"Ontwerp
\n
\nDan zal het eindproces er als volgt uitzien:<\/p>\n

    \n
  1. U maakt een sjabloon voor informatie van een bepaald type.<\/li>\n
  2. In dit sjabloon voegt u labels en pagina-eigenschappen toe in de macro.<\/li>\n
  3. Op elke gewenste plek maakt u een rootpagina met een knop, waarop bij klikken een subpagina uit de sjabloon wordt aangemaakt. <\/li>\n
  4. U laat gebruikers toegang krijgen tot de rootpagina, die potentieel de benodigde informatie (volgens het juiste sjabloon, door op de knop te drukken) zullen genereren.<\/li>\n
  5. U verzamelt uw rapport over de eigenschappen van de pagina via de labels die u in de sjabloon hebt opgegeven.<\/li>\n
  6. U verheugt zich: u heeft alle benodigde informatie in een handig formaat. <\/li>\n<\/ol>\n

    \"Ontwerp
    \n<\/p>\n

    Valtjes<\/h3>\n

    \nAls kwaliteitsingenieur kan ik met zekerheid zeggen dat er niets perfect is in de wereld. Zelfs goddelijke tabellen zijn niet perfect. En in het bovenstaande proces zijn er enkele hobbels.<\/p>\n