Hallo jiddereen!
Mäin Numm ass Masha, ech schaffen als Qualitéitssécherungsingenieur an der Tinkoff Grupp vu Firmen. QA Aarbecht implizéiert vill Kommunikatioun mat verschiddene Leit aus verschiddenen Équipen, an ech war och e Manager an Dozent vun edukativ Programmer, sou war meng Kommunikatioun Kaart sou breet wéi méiglech. An iergendwann sinn ech explodéiert: Ech hu gemierkt datt ech net méi kann, ech kann net, ech kann net hellesch Tonnen vun onliesbaren Dëscher an Dokumenter ausfëllen.
Sécher huet jidderee vun iech elo virgestallt, vu wat ech schwätzen, an ass kale Schweess ausgebrach: Lëschte mat Familljennumm ouni alphabetesch Uerdnung, Dëscher mat honnerte vu Kolonnen mat engem schlëmmen Layout, Dëscher mat Dausende vun Zeilen, an deenen Dir Äre Fanger muss läschen op der Mausrad fir Rubrik ze kucken, Tonne Säiten vun onnummeréierten Instruktiounen, Honnerte vu Bréiwer unenee geschéckt mat Daten, déi analyséiert a systematiséiert musse ginn an an déiselwecht onliesbar Dëscher gestoppt ginn.
An also, wéi ech e bëssen ofgekillt hunn, hunn ech decidéiert dësen Artikel ze schreiwen. Ech wäert schwätzen iwwer wéi Dir normalerweis (och heiansdo bequem) eng Vielfalt vun net-Produktdokumentatioun erhalen kënnt. Ech hoffen, datt den Artikel iwwer d'Netz verbreet gëtt an den Niveau vun der Häll an den Departementer niewent der Entwécklung op d'mannst e bësse falen, an d'Leit (och ech) wäerten e bësse méi glécklech ginn.
Tools
Produktdokumentatioun gëtt dacks niewent dem Code gehal, wat eng gutt Saach ass. An net-Produktdokumentatioun gëtt normalerweis iwwerall gelagert. Dacks probéieren d'Leit Informatioun vu verschiddene Plazen an d'Confluence ze bréngen, a mir si keng Ausnahm. Also de Rescht vun der Geschicht ass iwwer hien.
Am Allgemengen ass Confluence en fortgeschrattene Wiki-Motor. Et erlaabt Iech mat Daten an verschidden Aarte vu Display ze schaffen: Text mat Formatéierung, Dëscher, verschidde Charts. Dëst ass e ganz interessant a mächtegt Tool, awer wann Dir net wësst wéi Dir et kachen, da kritt Dir en anere Dump vun onliesbaren Dokumenter. Ech wäert Iech léieren wéi Dir kachen!
Makroen
Bal all d'Magie vu Confluence ass ronderëm Makroen opgebaut. Et gi vill Makroen, a si kënne matenee kombinéiert ginn. Si sinn bezuelt a gratis, weider ginn et verschidde Beispiller vun macros mat Linken op Dokumentatioun fir si.
D'Interface fir mat Makroen ze schaffen ass sou einfach wéi méiglech. Fir e Makro ze addéieren, musst Dir op de Plus klickt a wielt dat gewënscht Element aus der Lëscht.
Wann de Makro selbstverständlech ass, dat heescht, et erfuerdert net d'Insertion vun eppes anescht a sech selwer, et gesäit aus wéi e Block.
Wann e Makro eppes dran brauch fir ze schaffen, gesäit et aus wéi eng Këscht.
Zur selwechter Zäit kënnt Dir esou vill anerer wéi Dir wëllt an engem Frame setzen, soulaang et Logik an Ärer Pyramid ass.
All Makro huet eng Virschau: et weist direkt ob Dir de Makro richteg ausgefëllt an konfiguréiert hutt.
Schablounen
Zousätzlech zu Makroen gëtt et e praktescht Tool fir Inhalter viraus ze fëllen - dëst ass eng Schabloun.
Schabloune kënne benotzt ginn wann Dir eng Säit erstellt: klickt einfach op déi dräi Punkten nieft dem "Erstellen" Knäppchen a wielt déi gewënschte Schabloun.
Da gëtt all den Inhalt, deen an der Schabloun ass, op déi erstallt Säit bäigefüügt.
Jiddereen kann Säiten aus Templates erstellen, awer nëmmen déi, déi d'Rechter hunn fir Templates selwer ze kreéieren oder z'änneren, kënnen Säiten erstellen. Dir kënnt zousätzlech Instruktioune fir d'Schabloun addéieren iwwer wéi d'Säit erhale soll ginn.
Dësch Magic
Eigentlech, als Techniker, hunn ech Dëscher gär a ka bal all Informatioun dran packen (och wann dëst net ëmmer effektiv ass). D'Dëscher selwer sinn kloer, strukturéiert, skalierbar, magesch!
Awer och sou eng wonnerbar Entitéit wéi en Dësch ka verduerwe ginn. An et kann erfollegräich benotzt a souguer verbessert ginn. Méi doriwwer ënnendrënner.
Filteren (bezuelte Plugin)
All riseg onliesbar Dësch kann e bësse manner grouss an e bësse méi liesbar mat Filteren gemaach ginn. Fir dëst ze maachen, kënnt Dir e bezuelte Makro benotzen .
An dësem Makro musst Dir en Dësch drécken (och deen ellensten ass méiglech, den Haapt Saach ass et ganz ze drécken). Am Makro kënnt Dir Spalten fir Dropdown-Filter, Textfilter, numeresch an Datumfilter auswielen.
Stellt Iech vir datt all Informatioun iwwer Kandidaten fir all Vakanzen an enger Tabellelëscht opgeholl gëtt. Natierlech, ongesortéiert - Leit kommen net op d'Interviewen an alphabetesch Uerdnung. An Dir musst verstoen ob Dir e spezifesche Bewerber virdru interviewt hutt. Dir musst just dës Hell an e Filtermakro setzen, en Textfilter mam Familljennumm derbäisetzen - a voila, d'Informatioun ass op Ärem Écran.
Et ass derwäert ze notéieren datt d'Filteréiere vun riesegen Dëscher d'Systemleistung an d'Säitbelaaschtzäit beaflosse kann, sou datt e riesegen Dësch an de Filter setzen ass eng temporär Krut, et ass besser e Prozess ze bauen an deem d'Leit net grouss onliesbar Dëscher mussen erstellen (an Beispill vum Prozess wäert um Enn vum Artikel sinn).
Sortéieren (bezuelte Plugin)
Mat Magic Macro Dir kënnt och d'Standardsortéierung op all Kolonn setzen an d'Reihen nummeréieren. Oder klickt op eng Kolonn vun der Tabell, déi an de Filtermakro gesat gëtt, a Sortéierung no dëser Kolonn geschitt.
Zum Beispill, Dir hutt dee selwechten Dësch mat Bewerberinnen an Dir musst erausfannen wéivill Interviewen an engem bestëmmte Mount ofgehale goufen - no Datum sortéieren a freeën.
Pivot Dëscher (bezuelte Plugin)
Loosst eis elo op e méi interessanten Fall goen. Stellt Iech vir datt Ären Dësch rieseg ass an Dir musst eppes driwwer ausrechnen. Natierlech kënnt Dir et op Excel kopéieren, berechent wat Dir braucht an d'Donnéeën zréck op Confluence eropluede. Kënnt Dir e Macro eemol applizéieren? a kréien déi selwecht Resultat, nëmmen aktualiséiert.
Zum Beispill: Dir hutt eng Tabell déi d'Donnéeë vun all Mataarbechter enthält - wou se geographesch lokaliséiert sinn a wéi eng Positiounen se hunn. Fir ze berechnen wéivill Leit an all Stad sinn, musst Dir an der "Pivot Table" Macro d'Zeil auswielen, duerch déi d'Daten aggregéiert sinn (Plaz) an d'Zort vun der Operatioun (Zousätz).
Natierlech kënnt Dir no verschiddene Critèren gläichzäiteg gruppéieren, Dir kënnt all d'Méiglechkeeten gesinn .
Charts (bezuelte Plugin)
Wéi gesot, net jiddereen gär Dëscher sou vill wéi ech. Leider hunn déi meescht Manager se guer net gär. Awer jidderee gär hell Faarf Charts.
D'Creatoren vu Confluence woussten sécher iwwer dëst (sëcher hunn se och Bosse déi Berichter an Charts gär hunn, wou wieren se ouni et). Dofir kënnt Dir de Magie Makro benotzen . An dësem Makro musst Dir de Pivot-Tabelle aus dem virege Paragraph setzen, a voila - Är langweileg gro Daten si wonnerschéin visualiséiert.
Natierlech huet dëse Makro och Astellungen. E Link op d'Dokumentatioun fir all Makro kann am Editéiermodus vun deem Makro fonnt ginn.
Einfachheet vun Aggregatioun
D'Informatioun aus de fréiere Paragrafen war wahrscheinlech keng Offenbarung fir Iech. Awer elo wësst Dir definitiv wéi Macroen benotzt, an ech kann op de méi interessanten Deel vum Artikel goen.
Labels
Et ass schlecht wann d'Leit Informatioun an engem onstrukturéierten Artikel oder an engem risegen Dësch späicheren. Nach méi schlëmm ass wann Deeler vun dëser Informatioun net nëmmen onliesbar sinn, awer och iwwer d'Ausdehnen vu Confluence verspreet sinn. Glécklecherweis ass et méiglech verspreet Informatioun op enger Plaz ze sammelen. Fir dëst musst Dir benotzen (Tags bekannt fir jiddereen op sozialen Netzwierker).
All Zuel vun Tags kann op all Säit bäigefüügt ginn. Klickt op e Tag bréngt Iech op eng Aggregatiounssäit mat Linken op all Inhalt mat deem Tag, souwéi eng Rei vu verwandte Tags. Zesummenhang Tags sinn déi, déi dacks op der selwechter Säit erschéngen.
Säit Eegeschafte
Dir kënnt en aneren interessanten Makro op d'Säit derbäi fir Informatioun ze strukturéieren - . Bannen ass et néideg eng Tabell vun zwou Kolonnen ofzeginn, déi éischt ass de Schlëssel, an déi zweet ass de Wäert vun der Immobilie. Ausserdeem kann de Makro vun der Säit verstoppt ginn, sou datt et net mam Liesen vum Inhalt stéiert, awer d'Säit gëtt ëmmer nach mat den néidege Schlësselen markéiert.
Opgepasst op d'ID - et ass bequem et ze setzen fir verschidde Gruppen vun Eegeschaften op verschiddene Säiten ze hänken (oder souguer verschidde Gruppen vun Eegeschaften op enger Säit).
Berichter
Mat Tags kënnt Dir Berichter sammelen. Zum Beispill, Macro sammelt all Säiten mat engem bestëmmte Set vun Tags.
Awer e méi interessant Bericht ass e Makro . Et sammelt och all Säiten mat engem bestëmmte Set vun Tags, awer lëscht se net nëmmen, mee stellt eng Tabell zesummen (fänkt Dir d'Verbindung mam Ufank vum Artikel?), An deem d'Kolonn d'Schlëssel vun de Säiteigenschaften sinn.
Et stellt sech eraus e Resumé Dësch vun Informatiounen aus verschiddene Quellen. Et ass flott datt et praktesch Funktiounen huet: adaptiven Layout, Sortéierung no all Kolonn. Och esou eng Berichterstattung kann am Makro konfiguréiert ginn.
Wann Dir konfiguréiert, kënnt Dir e puer Sailen aus dem Bericht ewechhuelen, de Standardzoustand oder d'Zuel vun ugewisenen records setzen. Dir kënnt och d'Säit Eegeschafte ID setzen fir nëmmen d'Informatioun ze gesinn déi Dir braucht.
Zum Beispill, Dir hutt vill vun Employé Säiten, dës Säiten hunn eng Rei vun Eegeschaften iwwer eng Persoun: wat Niveau hien ass, wou hien ass, wann hien an d'Team ass, etc. Dës Eegeschafte sinn markéiert id = Employé_inf. An et gëtt eng zweet Set vun Eegeschaften op der selwechter Säit, déi Informatiounen iwwer eng Persoun als Deel vun engem Team enthält: wéi eng Roll spillt d'Persoun, a wéi engem Team hien ass, asw. Dës Eegeschafte sinn markéiert ID = team_inf. Dann, wann Dir e Bericht zesummestellt, kënnt Dir nëmmen Informatioun fir eng ID oder zwou gläichzäiteg weisen - wat och ëmmer méi bequem ass.
D'Schéinheet vun dëser Approche ass datt jiddereen d'Informatiounstabelle sammele kann déi se brauchen, déi näischt duplizéieren an aktualiséiert ginn wann d'Haaptsäit aktualiséiert gëtt. Zum Beispill: engem Teamleader ass egal wéi seng Entwéckler eng Aarbecht kréien, awer et ass wichteg wéi eng Roll jidderee vun hinnen am Team spillt. Den Teamleader sammelt e Bericht iwwer d'Team. An de Comptabel ass egal wien wéi eng Roll spillt, awer d'Positioune si wichteg - hien sammelt e Bericht iwwer d'Positiounen. An dësem Fall gëtt d'Informatiounsquell net duplizéiert oder iwwerdroen.
Finale Prozess
Instruktiounen
Also, mir kënne wonnerschéin strukturéieren an effektiv Informatioun a Confluence aggregéieren mat Makroen als Beispill. Awer am Idealfall musst Dir sécher sinn datt nei Informatioun direkt strukturéiert ass an an all d'Aggregatiounsmechanismen déi scho benotzt gëtt.
Hei kommen eng Rëtsch Makroen a Schablounen zur Rettung. Fir d'Leit ze kréien fir nei Säiten am richtege Format ze kreéieren, kënnt Dir de Makro aus Schabloun erstellen. Et füügt e Knäppchen op d'Säit, andeems Dir klickt op déi eng nei Säit erstallt gëtt aus der Schabloun déi Dir braucht. Op dës Manéier léisst Dir d'Leit direkt am Format schaffen, deen Dir braucht.
An der Schabloun, aus där Dir erlaabt eng Säit ze kreéieren, musst Dir Etiketten addéieren, de Macro "Page Properties" an eng Tabell vun den Eegeschaften déi Dir am Viraus braucht. Ech recommandéieren och Instruktiounen ze addéieren iwwer wéi eng Wäerter fir d'Säit ze fëllen an d'Eegeschaftswäerter.
Da wäert de leschte Prozess esou ausgesinn:
- Dir erstellt eng Schabloun fir eng spezifesch Zort Informatioun.
- An dëser Schabloun addéiere mer Etiketten a Säiteigenschaften an engem Makro.
- Op all praktesch Plaz, erstellt eng Root Säit mat engem Knäppchen, andeems Dir klickt op déi eng Kand Säit aus der Schabloun erstallt gëtt.
- Start op der Root Säit vun de Benotzer déi potenziell déi néideg Informatioun generéieren (no der gewënschter Schabloun, andeems Dir op de Knäppchen klickt).
- Sammelt Iech selwer e Bericht iwwer d'Eegeschafte vun der Säit duerch d'Tags déi Dir an der Schabloun uginn hutt.
- Freet Iech: Dir hutt all Informatioun déi Dir braucht an engem praktesche Format.
alleng
Als Qualitéitsingenieur kann ech sécher soen datt et näischt perfekt op der Welt gëtt. Och göttlech Dëscher sinn onvollstänneg. An et gi Fallen am uewe genannte Prozess.
- Wann Dir décidéiert d'Nimm oder d'Zesummesetzung vun de Säiteigenschaften z'änneren, musst Dir all déi scho geschafen Objeten aktualiséieren, sou datt hir Donnéeën richteg an de Resumébericht gezunn ginn. Dëst ass traureg, awer op der anerer Säit forcéiert et Iech am Detail iwwer d'"Architektur" vun Ärem Informatiounsset ze denken, wat eng ganz interessant Aufgab ass.
- Dir musst eng uerdentlech Quantitéit un Instruktioune schreiwen wéi Dir d'Informatiounstabellen ausfëllt an d'Tags benotzt. Awer op der anerer Säit kënnt Dir dësen Artikel just op all déi richteg Leit werfen.
E Beispill fir net-Produktdokumentatioun ze späicheren
Duerch de Prozess uewen beschriwwen, kënnt Dir d'Späichere vu bal all Informatioun organiséieren. D'Schéinheet vun der Approche ass datt et universell ass: Wann d'Benotzer sech dru gewinnt hunn, stoppen se e Chaos ze maachen. Och e groussen (awer net gratis) Plus ass d'Fäegkeet verschidde Statistiken op der Flucht ze sammelen a schéi Diagrammer drop ze zéien.
Ech ginn e Beispill vun eisem Prozess fir Informatioun iwwer d'Team z'erhalen.
Fir all Persoun am Team hu mir décidéiert eng Mataarbechterkaart ze kreéieren. Deementspriechend hu mir eng Schabloun no där all nei Persoun dës Kaart fir sech selwer erstellt an all seng perséinlech Informatioun dran hält.
Wéi Dir gesitt, hu mir eng detailléiert Tabelle vun Eegeschaften an hunn direkt Instruktioune fir dës Säit z'erhalen. E puer vun den Tags ginn vun de Mataarbechter selwer no den Instruktioune gesat, an der Schabloun nëmmen déi Haaptgrënn: de Kaartentag Employé-Kaart, Direktioun Tag Richtung-involvéieren an Kommando Tag team-qa.
Als Resultat, nodeems jiddereen eng Kaart fir sech selwer erstallt huet, gëtt e kompletten Dësch mat Informatioun iwwer Mataarbechter kritt. Dës Informatioun kann op verschiddene Punkte benotzt ginn. Ressource Manager kënnen allgemeng Dëscher fir sech sammelen, an Teamleit kënnen Kommandotabellen sammelen andeems en Teamtag an d'Auswiel bäigefüügt gëtt.
Vun Tags kënnt Dir verschidde Zesummefaassungen gesinn, zum Beispill, duerch qa-Upgrade-Plan all Aufgaben fir QA Entwécklung wäert ugewisen ginn. Zur selwechter Zäit hält all Persoun op senger Employéekaart eng wichteg Geschicht a säin eegene Entwécklungsplang - hien erstellt eng nestéiert Säit aus der Entwécklungspläng Schabloun.
Konklusioun
Halt all Dokumentatioun esou datt Dir Iech net schummt, an d'Benotzer sinn net onheemlech verletzt!
Ech hoffen wierklech datt den Artikel nëtzlech ass an Uerdnung an all Dokumentatioun vun der Welt kënnt.
Source: will.com