Hello!
A nevem Masha, minőségbiztosítási mérnökként dolgozom a Tinkoff cégcsoportnál. A minőségbiztosítási munka sok kommunikációt foglal magában különböző csapatokból származó emberekkel, emellett oktatási programok menedzsere és előadója is voltam, így a kommunikációs térképem a lehető legszélesebb volt. És egy ponton felrobbantam: rájöttem, hogy nem tudok, nem tudok, nem tudok pokolian tonna olvashatatlan táblázatot és dokumentumot kitölteni.
Bizonyára mindannyian elképzelték, miről beszélek, és kitört a hideg verejték: vezetéknevek listája ábécé sorrend nélkül, táblázatok több száz oszlopos görbe elrendezéssel, táblázatok több ezer sorral, amelyekben meg kell törölni az ujját. az egér görgőjén, hogy fejlécet nézzünk, rengeteg oldalnyi számozatlan utasítás, egymásnak küldött levelek százai olyan adatokkal, amelyeket elemezni és rendszerezni kell, és ugyanolyan olvashatatlan táblázatokba kell tölteni.
Így aztán, amikor kicsit lehűltem, úgy döntöttem, megírom ezt a cikket. Arról fogok beszélni, hogyan lehet normálisan (még néha kényelmesen is) karbantartani a különféle nem termékdokumentációkat. Remélem, hogy a cikk elterjed az interneten, és legalább egy kicsit csökken a pokol szintje a fejlesztéssel szomszédos osztályokon, és az emberek (beleértve én is) egy kicsit boldogabbak lesznek.
Tools
A termékdokumentációt gyakran a kód mellett tartják, ami jó dolog. A nem termékdokumentációkat pedig általában bárhol tárolják. Az emberek gyakran különböző helyekről próbálnak információkat áthelyezni a Confluence-be, és ez alól mi sem vagyunk kivételek. Tehát a történet többi része róla szól.
Általában véve a Confluence egy fejlett wikimotor. Lehetővé teszi, hogy különböző típusú megjelenítési adatokkal dolgozzon: szöveg formázással, táblázatok, különféle diagramok. Ez egy nagyon érdekes és hatékony eszköz, de ha nem tudja, hogyan kell elkészíteni, akkor a végén újabb olvashatatlan dokumentumokat kap. Megtanítalak főzni!
Makrók
A Confluence szinte minden varázslata a makrókból származik. Nagyon sok makró létezik, és ezek kombinálhatók egymással. Lehetnek fizetősek vagy ingyenesek; az alábbiakban különféle makrók példák találhatók a hozzájuk tartozó dokumentációra mutató hivatkozásokkal.
A makrók kezelésének felülete a lehető legegyszerűbb. Makró hozzáadásához kattintson a pluszjelre, és válassza ki a kívánt elemet a listából.
Ha egy makró önálló, azaz nem igényel mást önmagába, akkor blokknak néz ki.
Ha egy makró működéséhez valamit el kell helyezni benne, akkor az úgy néz ki, mint egy keret.
Ugyanakkor tetszőleges számú másikat elhelyezhetsz egy keretben, amíg van logika a piramisodban.
Minden makrónak van előnézete: azonnal megmutatja, hogy helyesen töltötte-e ki és konfigurálta-e a makrót.
sablonok
A makrók mellett van egy kényelmes eszköz a tartalom előre kitöltéséhez - egy sablon.
A sablonok bármely oldal létrehozásakor használhatók: csak kattintson a „Létrehozás” gomb melletti három pontra, és válassza ki a kívánt sablont.
Ezután a sablonban lévő összes tartalom hozzáadódik a létrehozott oldalhoz.
Sablonokból oldalakat bárki létrehozhat, de erre csak azok tehetnek, akik jogosultak maguk a sablonok létrehozására vagy szerkesztésére. A sablonhoz további utasításokat adhat az oldal karbantartására vonatkozóan.
Az asztalok varázsa
Valójában technikusként nagyon szeretem a táblázatokat, és szinte bármilyen információt be tudok csomagolni (bár ez nem mindig hatékony). Maguk a táblázatok áttekinthetők, strukturáltak, méretezhetők, varázslatosak!
De még egy olyan csodálatos entitás is tönkremehet, mint egy asztal. És sikeresen használhatja, sőt javíthatja is. Erről bővebben alább.
Szűrés (fizetős bővítmény)
Bármilyen hatalmas, olvashatatlan táblázat egy kicsit kevésbé hatalmasra és egy kicsit olvashatóbbá tehető szűréssel. Ehhez használhat fizetős makrót .
Ebbe a makróba be kell rakni egy táblázatot (még a legrondábbat is lehet, a lényeg, hogy teljes egészében toljuk). A makróban kiválaszthatja az oszlopokat a legördülő szűrőhöz, a szövegszűrőhöz, a számszűrőhöz és a dátumszűrőhöz.
Képzelje el, hogy az összes megüresedett pályázóra vonatkozó minden információ táblázatos listában van rögzítve. Természetesen válogatás nélkül - az emberek nem ábécé sorrendben jönnek az interjúkra. És meg kell értenie, hogy interjút készített-e korábban egy adott jelentkezővel. Csak be kell helyeznie ezt a poklot egy szűrőmakróba, hozzá kell adnia egy szövegszűrőt vezetéknév alapján - és íme, az információ a képernyőn van.
Érdemes megjegyezni, hogy a hatalmas táblák szűrése hatással lehet a rendszer teljesítményére és az oldalbetöltési időkre, ezért egy hatalmas táblázat szűrőbe helyezése átmeneti mankó; jobb egy olyan folyamatot felépíteni, amelyben az embereknek nem kell hatalmas, olvashatatlan táblázatokat létrehozniuk (egy A folyamat példája a cikk végén található).
Rendezés (fizetős bővítmény)
Varázsmakró használata Beállíthatja az alapértelmezett rendezést bármely oszlopban, és számozhatja a sorokat. Vagy kattintson a szűrőmakróba beszúrt táblázat bármely oszlopára, és a rendezés az adott oszlop szerint történik.
Például ugyanaz a táblázat van a jelentkezőkkel, és meg kell becsülnie, hogy hány interjút készítettek egy adott hónapban – rendezze dátum szerint, és legyen boldog.
Pivot táblázatok (fizetős bővítmény)
Most térjünk át egy érdekesebb esetre. Képzelje el, hogy a táblázata hatalmas, és ki kell számolnia belőle valamit. Természetesen bemásolhatja Excelbe, kiszámolhatja, hogy mire van szüksége, és visszatöltheti az adatokat a Confluence-ba. Használhatod egyszer a makrót? és ugyanazt az eredményt kapja, csak frissítve.
Például: van egy táblázata, amely az összes alkalmazott adatait gyűjti – földrajzi elhelyezkedésükről és beosztásukról. Annak kiszámításához, hogy hány ember tartózkodik az egyes városokban, ki kell választania a kimutatás makróban azt a sort, amely összesíti az adatokat (helyszínt) és a művelet típusát (kiegészítés).
Természetesen egyszerre több szempont szerint csoportosítható, minden lehetőség megtekinthető .
Diagramok (fizetős bővítmény)
Mint mondtam, nem mindenki szereti annyira az asztalokat, mint én. Sajnos a legtöbb menedzser egyáltalán nem szereti őket. De mindenki nagyon szereti az élénk színű diagramokat.
A Confluence készítői ezt bizonyára tudták (valószínűleg vannak olyan főnökeik is, akik szeretik a riportokat, diagramokat, hol tartanának nélküle). Ezért használhatja a varázsmakrót . Ebben a makróban el kell helyeznie az előző bekezdés pivot tábláját, és íme - a szürke unalmas adatai gyönyörűen láthatók.
Természetesen ennek a makrónak is vannak beállításai. Bármely makró dokumentációjához mutató hivatkozás található az adott makró szerkesztési módjában.
Könnyű összesítés
Az előző bekezdésekből származó információ valószínűleg nem jelentett kinyilatkoztatást az Ön számára. De most már biztosan tudja, hogyan kell makrókat használni, és áttérhetek a cikk érdekesebb részére.
Címkék
Rossz, ha az emberek egyetlen strukturálatlan cikkben vagy egy hatalmas táblázatban tárolják az információkat. Még rosszabb, ha ezeknek az információknak egyes részei nem csak olvashatatlan formátumúak, hanem szétszórva is vannak a Confluence-ben. Szerencsére egy helyen is össze lehet gyűjteni a szétszórt információkat. Ehhez használni kell (mindenki számára ismerős címkék a közösségi hálózatokról).
Bármely oldalhoz tetszőleges számú címkét adhat hozzá. Egy címkére kattintva egy összesítő oldalra jut, amelyen az adott címkével rendelkező összes tartalomra mutató hivatkozások, valamint a kapcsolódó címkék készlete találhatók. A kapcsolódó címkék azok, amelyek gyakran megjelennek ugyanazon az oldalon.
Az oldal tulajdonságai
Hozzáadhat egy másik érdekes makrót az oldalhoz az információk strukturálásához - . Ezen belül egy két oszlopból álló táblázatot kell beküldeni, az első a kulcs, a második pedig az ingatlan értéke. Sőt, a makró elrejthető az oldal elől, hogy ne zavarja a tartalom olvasását, de az oldal továbbra is meg lesz jelölve a szükséges gombokkal.
Ügyeljen az azonosítóra - kényelmesen beállíthatja, hogy különböző tulajdonságcsoportokat rendeljen különböző oldalakhoz (vagy akár különböző tulajdonságcsoportokat egy oldalhoz).
jelentések
A címkék segítségével jelentéseket gyűjthet. Például makró összegyűjti az összes olyan oldalt, amelyek meghatározott címkékkel rendelkeznek.
De egy érdekesebb jelentés a makró . Össze is gyűjti az összes olyan oldalt, ahol bizonyos címkekészletek vannak, de nem csak listát jelenít meg ezekről, hanem létrehoz egy táblázatot (megkapod a kapcsolatot a cikk elejével?), amelyben az oszlopok az oldal tulajdonkulcsok.
Az eredmény egy összefoglaló táblázat különböző forrásokból származó információkkal. Jó, hogy kényelmes funkciókkal rendelkezik: adaptív elrendezés, tetszőleges oszlop szerinti rendezés. Ezenkívül egy ilyen jelentési táblázat konfigurálható egy makrón belül.
A konfigurálás során eltávolíthat néhány oszlopot a jelentésből, beállíthat egy alapértelmezett állapotot vagy a megjelenített rekordok számát. Az oldaltulajdon-azonosítót úgy is beállíthatja, hogy csak a szükséges információkat lássa.
Például sok alkalmazotti oldala van, ezeken az oldalakon van egy tulajdonságkészlet az adott személyről: milyen szinten van, hol van, mikor csatlakozott a csapathoz stb. Ezek a tulajdonságok meg vannak jelölve ID = munkavállaló_inf. És van egy második tulajdonságkészlet ugyanazon az oldalon, amely információkat tartalmaz a személyről a csapat tagjaként: milyen szerepet játszik az illető, melyik csapatban van és így tovább. Ezek a tulajdonságok meg vannak jelölve ID = team_inf. Ezután a jelentés összeállításakor egyszerre csak egy vagy két azonosító adatait jelenítheti meg - melyik a kényelmesebb.
Ennek a megközelítésnek az a szépsége, hogy mindenki összeállíthatja a számára szükséges információs táblázatot, amely nem duplikál semmit, és a főoldal frissítésekor frissül. Például: egy csapatvezetőnek nem mindegy, hogy a fejlesztői mikor kaptak munkát, hanem az, hogy ki-ki milyen szerepet tölt be a csapatban. A csapatvezető jelentést készít a csapatról. És a könyvelőt általában nem érdekli, hogy ki milyen szerepet tölt be, de a pozíciók fontosak - jelentést készít a pozíciókról. Ebben az esetben az információforrás nem kerül sokszorosításra vagy átvitelre.
Végső folyamat
Oktatás
Így például makrók használatával szépen strukturálhatjuk és hatékonyan összesíthetjük az információkat a Confluence-ben. Ideális esetben azonban meg kell győződnie arról, hogy az új információ azonnal strukturált, és beleesik a már használatban lévő összesítési mechanizmusba.
Itt egy csomó makró és sablon fog megmenteni. Ha arra kényszeríti az embereket, hogy új oldalakat hozzanak létre a kívánt formátumban, használhatja a Létrehozás sablonból makrót. Hozzáad egy gombot az oldalhoz, rákattintásra egy új oldal jön létre a szükséges sablonból. Ezzel arra kényszeríti az embereket, hogy azonnal a szükséges formátumban dolgozzanak.
Abban a sablonban, amelyből oldalt hoz létre, előzetesen hozzá kell adnia a címkéket, az „Oldaltulajdonságok” makrót és a szükséges tulajdonságok táblázatát. Azt is javaslom, hogy adjon meg utasításokat arra vonatkozóan, hogy milyen értékeket és tulajdonságértékeket kell kitölteni az oldalon.
Ezután a végső folyamat így fog kinézni:
- Egy adott típusú információhoz sablont hoz létre.
- Ebben a sablonban címkéket és oldaltulajdonságokat adhat hozzá egy makróban.
- Bármilyen kényelmes helyen hozzon létre egy gyökéroldalt egy gombbal, amelyre kattintva létrehoz egy gyermekoldalt a sablonból.
- Engedélyezi a felhasználókat a gyökéroldalra, akik potenciálisan generálják a szükséges információkat (a kívánt sablon szerint, egy gombra kattintva).
- Az oldal tulajdonságairól jelentést gyűjt a sablonban megadott címkék használatával.
- Örülj: minden szükséges információ birtokában van egy kényelmes formátumban.
Buktatók
Minőségügyi mérnökként nyugodtan állíthatom, hogy a világon semmi sem tökéletes. Még az isteni asztalok is tökéletlenek. És a fenti folyamatnak vannak buktatói.
- Ha úgy dönt, hogy megváltoztatja az oldaltulajdonságok nevét vagy összetételét, frissítenie kell az összes már létrehozott objektumot, hogy az adatok helyesen szerepeljenek az összefoglaló jelentésben. Ez szomorú, de másrészt arra kényszerít, hogy részletesen elgondolkodjon az információs halmaza „architektúráján”, ami nagyon érdekes feladat.
- Megfelelő mennyiségű utasítást kell írnia az információs táblázatok kitöltéséhez és a címkék használatához. Másrészt ezzel a cikkel minden megfelelő embert eltalálhatsz.
Példa a nem termékdokumentáció tárolására
A fent leírt eljárással szinte bármilyen információ tárolását megszervezheti. A megközelítés szépsége abban rejlik, hogy univerzális: amint a felhasználók megszokják, abbahagyják a rendetlenséget. Egy másik nagy (de nem ingyenes) plusz az a lehetőség, hogy menet közben gyűjthetünk különféle statisztikákat, és ezek alapján gyönyörű diagramokat rajzolhatunk.
Hadd mutassak egy példát a csapattal kapcsolatos információk karbantartásának folyamatára.
Úgy döntöttünk, hogy a csapat minden tagja számára létrehozunk egy alkalmazotti kártyát. Ennek megfelelően van egy sablonunk, amely szerint minden új személy létrehozza magának ezt a kártyát, és minden személyes adatot tárol benne.
Amint látja, van egy részletes tulajdonságtáblázatunk, és azonnal utasításokat is kapunk az oldal karbantartására vonatkozóan. A címkék egy részét maguk az alkalmazottak adják hozzá az utasításoknak megfelelően, a sablon csak a főbbeket tartalmazza: a kártyacímkét alkalmazotti kártya, irányjelző címke irány-bevonja és csapattag csapat-qa.
Ennek eredményeként, miután mindenki létrehozott magának egy kártyát, egy teljes táblázatot kapunk az alkalmazottakra vonatkozó információkkal. Ez az információ különböző pontokon használható fel. Az erőforrás-menedzserek általános táblázatokat gyűjthetnek maguknak, a csapatvezetők pedig csoporttáblázatokat hozhatnak létre úgy, hogy csapatcímkét adnak a kijelöléshez.
Különféle összefoglalókat láthat például címkék szerint qa-upgrade-terv Az összes minőségbiztosítási fejlesztési feladat megjelenik. Ugyanakkor minden ember fontos előzményeket és saját fejlesztési tervet őriz az alkalmazotti igazolványában - a fejlesztési tervek sablonból beágyazott oldalt hoz létre.
Következtetés
Minden dokumentációt úgy kell kezelni, hogy ne legyen benne szégyen, és ne okozzon elviselhetetlen fájdalmat a felhasználóknak!
Nagyon remélem, hogy a cikk hasznos lesz, és rend lesz a világ összes dokumentációjában.
Forrás: will.com