Привет!
Менің атым Маша, мен Tinkoff компаниялар тобында сапаны қамтамасыз ету жөніндегі инженер болып жұмыс істеймін. QA жұмысы әртүрлі командалардағы әртүрлі адамдармен көп қарым-қатынасты қамтиды, мен де білім беру бағдарламаларының менеджері және оқытушысы болдым, сондықтан менің коммуникация картасы мүмкіндігінше кең болды. Бір кезде мен жарылып кеттім: мен енді оқуға болмайтын кестелер мен құжаттарды толтыра алмайтынымды, жасай алмайтынымды және толтыра алмайтынымды түсіндім.
Әрине, сіздердің әрқайсысыңыз менің айтып отырғанымды елестетіп, суық терге түсті: алфавиттік тәртіпсіз фамилиялар тізімі, немқұрайлы орналасуы бар жүздеген бағандардан тұратын кестелер, саусағыңызды өшіру керек мыңдаған жолдар бар кестелер тақырыпты қарау үшін тінтуірдің дөңгелегінде, нөмірленбеген нұсқаулардың тонна беттері, талдауды және жүйелеуді және бірдей оқылмайтын кестелерге толтыруды қажет ететін деректермен бір-біріне жіберілген жүздеген хаттар.
Сөйтіп, біраз суыған соң осы мақаланы жазуды жөн көрдім. Мен әртүрлі өнімге жатпайтын құжаттаманы әдеттегідей (тіпті кейде ыңғайлы) қалай жүргізуге болатыны туралы айтатын боламын. Мақала желіде шашырап, дамуға іргелес департаменттердегі тозақ деңгейі кем дегенде аздап төмендейді және адамдар (оның ішінде мен де) аздап бақытты болады деп үміттенемін.
Құралдар
Өнім құжаттамасы жиі кодпен бірге сақталады, бұл жақсы нәрсе. Ал өнімге жатпайтын құжаттама әдетте кез келген жерде сақталады. Көбінесе адамдар Конфлуенске әртүрлі жерлерден ақпаратты жеткізуге тырысады, біз де ерекшелік емеспіз. Сонымен, әңгіменің қалған бөлігі ол туралы.
Жалпы алғанда, Confluence - жетілдірілген вики қозғалтқышы. Ол әртүрлі дисплей түрлерінде деректермен жұмыс істеуге мүмкіндік береді: пішімі бар мәтін, кестелер, әртүрлі диаграммалар. Бұл өте қызықты және күшті құрал, бірақ оны қалай дайындауды білмесеңіз, оқылмайтын құжаттардың тағы бір үйіндісін аласыз. Мен саған тамақ жасауды үйретемін!
макростар
Confluence сиқырының барлығы дерлік макростардың айналасында құрылған. Көптеген макростар бар және оларды бір-бірімен біріктіруге болады. Олар ақылы және тегін, әрі қарай олар үшін құжаттамаға сілтемелері бар макростардың әртүрлі мысалдары болады.
Макростармен жұмыс істеу интерфейсі мүмкіндігінше қарапайым. Макросты қосу үшін плюс белгішесін басып, тізімнен қажетті элементті таңдау керек.
Егер макрос өзін-өзі қамтамасыз етсе, яғни оның ішіне басқа нәрсені енгізуді қажет етпесе, ол блокқа ұқсайды.
Егер макрос жұмыс істеу үшін оның ішінде бірдеңе қажет болса, ол қорапқа ұқсайды.
Сонымен қатар, пирамидаңызда логика болса, бір кадрдың ішіне қалағаныңызша басқаларды қоюға болады.
Әрбір макросты алдын ала қарау мүмкіндігі бар: ол сіздің макросты дұрыс толтырғаныңызды және конфигурациялағаныңызды бірден көрсетеді.
үлгілер
Макростардан басқа, мазмұнды алдын ала толтырудың ыңғайлы құралы бар - бұл үлгі.
Үлгілерді кез келген бетті жасау кезінде пайдалануға болады: «Жасау» түймесінің жанындағы үш нүктені басып, қажетті үлгіні таңдау жеткілікті.
Содан кейін үлгідегі барлық мазмұн жасалған бетке қосылады.
Кез келген адам үлгілерден беттер жасай алады, бірақ үлгілерді өзі жасау немесе өңдеу құқығы барлар ғана беттерді жасай алады. Үлгіге бетті қалай ұстау керектігі туралы қосымша нұсқаулар қосуға болады.
Сиқырлы кесте
Шындығында, техник ретінде мен кестелерді жақсы көремін және оларға кез келген дерлік ақпаратты орап аламын (бірақ бұл әрқашан тиімді емес). Кестелердің өзі анық, құрылымды, масштабталатын, сиқырлы!
Бірақ тіпті үстел сияқты керемет заттың бұзылуы мүмкін. Және оны сәтті қолдануға және тіпті жақсартуға болады. Бұл туралы толығырақ төменде.
Сүзу (ақылы плагин)
Кез келген үлкен оқылмайтын кестені сүзгілеу арқылы аздап кішірек және оқуға ыңғайлы етіп жасауға болады. Ол үшін ақылы макросты пайдалануға болады .
Бұл макростың ішінде сіз үстелді итеруіңіз керек (тіпті ең ұсқынсыз болуы мүмкін, бастысы оны толығымен итеру). Макроста ашылмалы сүзгі, мәтін сүзгісі, сандық және күн сүзгісі үшін бағандарды таңдауға болады.
Барлық бос орындарға үміткерлер туралы барлық ақпарат кестелік тізімде жазылғанын елестетіп көріңіз. Әрине, сұрыпталмаған - адамдар сұхбатқа алфавит бойынша келмейді. Сіз бұрын белгілі бір өтініш берушімен сұхбаттасқаныңызды түсінуіңіз керек. Сізге бұл тозақты сүзгі макросына қою керек, фамилия бойынша мәтіндік сүзгіні қосу керек - және voila, ақпарат сіздің экраныңызда.
Айта кету керек, үлкен кестелерді сүзу жүйенің жұмысына және беттің жүктелу уақытына әсер етуі мүмкін, сондықтан сүзгіге үлкен кесте қою уақытша балдақ болып табылады, адамдарға үлкен оқылмайтын кестелерді (жүктеу) жасаудың қажеті жоқ процесті құрған дұрыс. процестің мысалы мақаланың соңында болады).
Сұрыптау (ақылы плагин)
Сиқырлы макроспен кез келген бағанға әдепкі сұрыптауды орнатуға және жолдарды нөмірлеуге болады. Немесе сүзгі макросқа қойылған кестенің кез келген бағанын шертсеңіз, осы баған бойынша сұрыптау орын алады.
Мысалы, сізде үміткерлермен бірдей кесте бар және сіз белгілі бір айда қанша сұхбат өткенін анықтауыңыз керек - күні бойынша сұрыптаңыз және қуаныңыз.
Жиынтық кестелер (ақылы плагин)
Енді қызықтырақ іске көшейік. Сіздің үстеліңіз үлкен және оған бірдеңе есептеу керек деп елестетіп көріңіз. Әрине, оны Excel бағдарламасына көшіріп, қажет нәрсені есептеп, деректерді Confluence-ке кері жүктеп салуға болады. Макросты бір рет қолдана аласыз ба? және бірдей нәтиже алыңыз, тек жаңартылған.
Мысалы: сізде барлық қызметкерлердің деректерін қамтитын кесте бар - олар географиялық тұрғыдан қайда орналасқан және қандай лауазымдарға ие. Әр қалада қанша адам бар екенін есептеу үшін «Жиынтық кесте» макросында деректер біріктірілетін жолды (орын) және операция түрін (қосу) таңдау керек.
Әрине, сіз бірден бірнеше критерий бойынша топтауға болады, сіз барлық мүмкіндіктерді көре аласыз .
Диаграммалар (ақылы плагин)
Жоғарыда айтқанымдай, бәрі мен сияқты дастарханды жақсы көрмейді. Өкінішке орай, менеджерлердің көпшілігі оларды мүлдем ұнатпайды. Бірақ бәрі ашық түсті диаграммаларды жақсы көреді.
Confluence жасаушылар бұл туралы әрине білетін (әрине оларда есептер мен диаграммаларды жақсы көретін бастықтары бар, онсыз олар қайда болар еді). Сондықтан сиқырлы макросты пайдалануға болады . Бұл макроста алдыңғы абзацтағы жиынтық кестені қою керек, ал voila - сіздің қызықсыз сұр деректеріңіз әдемі көрінеді.
Әрине, бұл макростың да параметрлері бар. Кез келген макростың құжаттамасына сілтемені сол макростың өңдеу режимінде табуға болады.
Агрегацияның қарапайымдылығы
Алдыңғы абзацтардағы ақпарат сіз үшін аян болмаған шығар. Бірақ енді сіз макростарды қалай пайдалану керектігін анық білесіз, мен мақаланың қызықты бөлігіне ауыса аламын.
Tags
Адамдар ақпаратты бір құрылымдалмаған мақалада немесе үлкен кестеде сақтаған кезде жаман. Одан да сорақысы, бұл ақпараттың бөліктері оқуға болмай, сонымен қатар Confluence кеңістігінде шашыраңқы болуы. Бақытымызға орай, шашыраңқы ақпаратты бір жерде жинауға болады. Ол үшін пайдалану керек (әлеуметтік желілерде барлығына таныс тегтер).
Кез келген бетке тегтердің кез келген санын қосуға болады. Тегті басу сізді осы тег бар барлық мазмұнға, сондай-ақ қатысты тегтер жиынтығына сілтемелері бар жинақтау бетіне апарады. Қатысты тегтер - бір бетте жиі пайда болатын тегтер.
Бет қасиеттері
Ақпаратты құрылымдау үшін бетке тағы бір қызықты макрос қосуға болады - . Оның ішінде сіз екі бағанның кестесін беруіңіз керек, біріншісі кілт болады, ал екіншісі сипаттың мәні болады. Сонымен қатар, макросты мазмұнды оқуға кедергі келтірмейтіндей етіп беттен жасыруға болады, бірақ бет әлі де қажетті пернелермен белгіленеді.
Идентификаторға назар аударыңыз - оны әртүрлі беттерде сипаттардың әртүрлі топтарын (немесе тіпті бір бетте әртүрлі сипаттар топтарын) ілу үшін орнату ыңғайлы.
Есептер
Тегтер арқылы есептерді жинауға болады. Мысалы, макро белгілі бір тегтер жинағы бар барлық беттерді жинайды.
Бірақ одан да қызықты есеп - макрос . Ол сондай-ақ белгілі бір тегтер жинағы бар барлық беттерді жинайды, бірақ оларды жай ғана тізімдеп қоймайды, кестені құрастырады (мақала басымен байланысты ұстайсыз ба?), Оның бағандары бет қасиеттерінің кілттері болып табылады.
Әртүрлі көздерден алынған ақпараттың жиынтық кестесі шығады. Оның ыңғайлы мүмкіндіктері бар екендігі жақсы: бейімделгіш орналасу, кез келген баған бойынша сұрыптау. Сондай-ақ, мұндай есеп беру кестесін макрос ішінде конфигурациялауға болады.
Конфигурациялау кезінде есептен кейбір бағандарды жоюға, әдепкі күйді немесе көрсетілген жазбалардың санын орнатуға болады. Сондай-ақ бет сипатының идентификаторын тек қажетті ақпаратты көру үшін орнатуға болады.
Мысалы, сізде көптеген қызметкерлер беттері бар, бұл беттерде адам туралы қасиеттер жиынтығы бар: ол қандай деңгейде, ол қайда, командаға қашан қосылды және т.б. Бұл қасиеттер белгіленген id = қызметкер_инф. Және сол бетте команданың бір бөлігі ретінде адам туралы ақпаратты қамтитын қасиеттердің екінші жиынтығы бар: адам қандай рөл атқарады, ол қандай командада және т.б. Бұл қасиеттер белгіленген ID = команда_инф. Содан кейін есепті құрастырған кезде бір немесе екі идентификаторға арналған ақпаратты ғана көрсете аласыз - қайсысы ыңғайлы болса.
Бұл тәсілдің сұлулығы мынада: әркім өзіне қажетті ақпарат кестесін жинай алады, ол ештеңені қайталамайды және негізгі бет жаңартылған кезде жаңартылады. Мысалы: топ басшысы оның әзірлеушілерінің қашан жұмысқа орналасқаны маңызды емес, бірақ олардың әрқайсысының командада қандай рөл атқаратыны маңызды. Топ басшысы топ туралы есеп жинайды. Бухгалтер кімнің қандай рөл атқаратыны маңызды емес, бірақ лауазымдар маңызды - ол позициялар туралы есеп жинайды. Бұл жағдайда ақпарат көзі қайталанбайды және тасымалданбайды.
Қорытынды процесс
Нұсқаулық
Осылайша, біз мысал ретінде макростарды пайдалана отырып, Confluence-те ақпаратты әдемі құрылымдауға және тиімді біріктіруге болады. Ең дұрысы, жаңа ақпараттың бірден құрылымдалғанына және қазірдің өзінде қолданылып жүрген барлық жинақтау механизмдеріне енетініне көз жеткізу керек.
Мұнда көптеген макростар мен шаблондар көмекке келеді. Адамдарды дұрыс пішімде жаңа беттер жасауға мүмкіндік беру үшін Үлгіден жасау макросын пайдалануға болады. Ол бетке түймені қосады, оны басу арқылы сізге қажет үлгіден жаңа бет жасалады. Осылайша сіз адамдарды бірден қажетті форматта жұмыс істеуге мәжбүр етесіз.
Бетті жасауға рұқсат беретін үлгіде белгілерді, «Бет сипаттары» макросын және алдын ала қажетті сипаттар кестесін қосу керек. Сондай-ақ, бетті қандай мәндермен толтыру және сипат мәндері туралы нұсқауларды қосуды ұсынамын.
Содан кейін соңғы процесс келесідей болады:
- Сіз белгілі бір ақпарат түріне үлгі жасап жатырсыз.
- Бұл үлгіде макросқа белгілер мен бет сипаттарын қосыңыз.
- Кез келген ыңғайлы жерде шаблоннан еншілес бет жасалатын түймені басу арқылы түбірлік бетті жасаңыз.
- Қажетті ақпаратты әлеуетті генерациялайтын пайдаланушылардың түбірлік бетінде іске қосыңыз (қажетті үлгіге сәйкес, түймені басу арқылы).
- Үлгіде көрсеткен тегтер арқылы беттің сипаттары туралы есеп жинаңыз.
- Қуаныңыз: сізде ыңғайлы форматта барлық қажетті ақпарат бар.
Төзімділік
Сапа инженері ретінде мен әлемде мінсіз ештеңе жоқ деп сенімді түрде айта аламын. Тіпті Құдайдың кестелері де кемелсіз. Және жоғарыда аталған процесте тұзақтар бар.
- Бет сипаттарының атауларын немесе құрамын өзгертуді шешсеңіз, олардың деректері жиынтық есепке дұрыс тартылуы үшін бұрыннан жасалған барлық нысандарды жаңарту керек болады. Бұл қайғылы, бірақ екінші жағынан, ол сізді ақпарат жинағыңыздың «архитектурасы» туралы егжей-тегжейлі ойлауға мәжбүр етеді, бұл өте қызықты тапсырма.
- Сізге ақпараттық кестелерді толтыру және тегтерді пайдалану туралы лайықты нұсқауларды жазу керек. Бірақ, екінші жағынан, сіз бұл мақаланы барлық дұрыс адамдарға лақтыра аласыз.
Өнімге жатпайтын құжаттаманы сақтау мысалы
Жоғарыда сипатталған процесс арқылы сіз кез келген дерлік ақпаратты сақтауды ұйымдастыра аласыз. Әдістің сұлулығы - бұл әмбебап: пайдаланушылар үйренгеннен кейін, олар тәртіпсіздік жасауды тоқтатады. Сондай-ақ үлкен (бірақ тегін емес) плюс - бұл әртүрлі статистиканы жылдам жинау және оған әдемі диаграммалар салу мүмкіндігі.
Мен команда туралы ақпаратты сақтау үдерісіне мысал келтіремін.
Командадағы әрбір адам үшін біз қызметкер картасын жасауды шештік. Тиісінше, бізде үлгі бар, оған сәйкес әрбір жаңа адам осы картаны өзі үшін жасайды және онда өзінің барлық жеке мәліметтерін сақтайды.
Көріп отырғаныңыздай, бізде сипаттардың егжей-тегжейлі кестесі бар және бірден осы бетті қалай ұстау керектігі туралы нұсқаулар бар. Кейбір тегтерді нұсқаулыққа сәйкес қызметкерлер өздері қояды, үлгіде тек негізгілері: карта белгісі қызметкер картасы, бағыт белгісі бағыт – тарту және пәрмен тегі команда-қа.
Нәтижесінде, әркім өзі үшін карта жасағаннан кейін, қызметкерлер туралы ақпарат бар толық кесте алынады. Бұл ақпаратты әртүрлі нүктелерде пайдалануға болады. Ресурс менеджерлері өздері үшін жалпы кестелерді жинай алады, ал топ жетекшілері таңдауға топ тегін қосу арқылы пәрмен кестелерін жинай алады.
Тегтер арқылы сіз әртүрлі қорытындыларды көре аласыз, мысалы, арқылы qa-жаңарту жоспары QA әзірлеуге арналған барлық тапсырмалар көрсетіледі. Бұл ретте әрбір адам өзінің қызметкер картасында маңызды оқиғаны және өзінің даму жоспарын сақтайды - ол даму жоспарларының үлгісінен кірістірілген бетті жасайды.
қорытынды
Кез келген құжаттаманы ұялмайтындай етіп сақтаңыз және пайдаланушылар қатты зардап шекпейді!
Мақала пайдалы болады деп үміттенемін және әлемнің барлық құжаттамасында тәртіп болады.
Ақпарат көзі: www.habr.com