Herkese Merhaba!
Benim adım Masha, Tinkoff şirketler grubunda kalite güvence mühendisi olarak çalışıyorum. QA işi, farklı ekiplerden farklı kişilerle çok fazla iletişim kurmayı içerir ve ben aynı zamanda eğitim programlarının yöneticisi ve eğitmeniydim, bu nedenle iletişim haritam olabildiğince genişti. Ve bir noktada patladım: Artık yapamayacağımı, yapamayacağımı, cehennem gibi tonlarca okunamayan tablo ve belgeyi dolduramayacağımı fark ettim.
Elbette her biriniz şimdi neden bahsettiğimi hayal ettiniz ve soğuk terler döktünüz: alfabetik sıraya sahip olmayan soyad listeleri, özensiz bir düzene sahip yüzlerce sütunlu tablolar, parmağınızı silmeniz gereken binlerce satırlı tablolar fare tekerleğinde başlığa bakmak, tonlarca sayfa numarasız talimat, analiz edilmesi ve sistematik hale getirilmesi ve aynı okunamaz tablolara doldurulması gereken verilerle birbirine gönderilen yüzlerce mektup.
Ve biraz soğuduğumda bu makaleyi yazmaya karar verdim. Normalde (hatta bazen uygun bir şekilde) çeşitli ürün dışı belgeleri nasıl koruyabileceğiniz hakkında konuşacağım. Umarım makale ağa dağılır ve geliştirmeye bitişik bölümlerdeki cehennem seviyesi en azından biraz düşer ve insanlar (ben dahil) biraz daha mutlu olur.
Araçlar
Ürün belgeleri genellikle kodun yanında tutulur ki bu iyi bir şeydir. Ve ürün dışı belgeler genellikle herhangi bir yerde saklanır. Çoğu zaman insanlar Confluence'a farklı yerlerden bilgi getirmeye çalışırlar ve biz de bir istisna değiliz. Yani hikayenin geri kalanı onunla ilgili.
Genel olarak, Confluence gelişmiş bir wiki motorudur. Farklı görüntüleme türlerindeki verilerle çalışmanıza olanak tanır: biçimlendirmeli metin, tablolar, çeşitli grafikler. Bu çok ilginç ve güçlü bir araçtır, ancak nasıl pişirileceğini bilmiyorsanız, o zaman başka bir okunamayan belge dökümü alırsınız. Sana yemek yapmayı öğreteceğim!
Makrolar
Confluence'ın neredeyse tüm büyüsü makrolar etrafında inşa edilmiştir. Birçok makro vardır ve bunlar birbirleriyle birleştirilebilir. Ücretli ve ücretsizdirler, ayrıca onlar için belgelere bağlantılar içeren çeşitli makro örnekleri olacaktır.
Makrolarla çalışmak için arayüz mümkün olduğunca basittir. Bir makro eklemek için artıya tıklamanız ve listeden istediğiniz öğeyi seçmeniz gerekir.
Makro kendi kendine yetiyorsa, yani kendi içine başka bir şey eklenmesini gerektirmiyorsa, blok görünümündedir.
Bir makronun çalışması için içinde bir şeye ihtiyacı varsa, bu bir kutu gibi görünür.
Aynı zamanda, piramidinizde mantık olduğu sürece, istediğiniz kadarını tek bir çerçeveye koyabilirsiniz.
Her makronun bir ön izlemesi vardır: hemen makroyu doğru şekilde doldurup yapılandırmadığınızı gösterir.
Şablonları
Makrolara ek olarak, içeriği önceden doldurmak için uygun bir araç vardır - bu bir şablondur.
Şablonlar herhangi bir sayfa oluşturulurken kullanılabilir: "Oluştur" düğmesinin yanındaki üç noktayı tıklamanız ve istediğiniz şablonu seçmeniz yeterlidir.
Ardından, şablondaki tüm içerik oluşturulan sayfaya eklenecektir.
Herkes şablonlardan sayfa oluşturabilir, ancak yalnızca şablon oluşturma veya düzenleme haklarına sahip olanlar sayfa oluşturabilir. Sayfanın nasıl sürdürülmesi gerektiğine ilişkin şablona ek talimatlar ekleyebilirsiniz.
Masa Büyüsü
Aslında, bir teknisyen olarak tabloları çok seviyorum ve hemen hemen her türlü bilgiyi içlerine sığdırabilirim (bu her zaman etkili olmasa da). Tabloların kendileri net, yapılandırılmış, ölçeklenebilir, büyülü!
Ancak masa gibi harika bir varlık bile bozulabilir. Ve başarıyla kullanılabilir ve hatta geliştirilebilir. Aşağıda bununla ilgili daha fazla bilgi var.
Filtreleme (ücretli eklenti)
Okunamayan herhangi bir büyük tablo, filtreleme kullanılarak biraz daha az büyük ve biraz daha okunabilir hale getirilebilir. Bunu yapmak için ücretli bir makro kullanabilirsiniz. .
Bu makronun içine bir masa itmeniz gerekiyor (en çirkini bile mümkün, asıl mesele onu tamamen itmek). Makroda, açılır filtre, metin filtresi, sayısal ve tarih filtresi için sütunlar seçebilirsiniz.
Tüm açık pozisyonlar için adaylarla ilgili tüm bilgilerin bir tablo halinde kaydedildiğini hayal edin. Doğal olarak, sıralanmamış - insanlar görüşmelere alfabetik sırayla gelmezler. Ve daha önce belirli bir başvuru sahibiyle görüşüp görüşmediğinizi anlamanız gerekir. Bu cehennemi bir filtre makrosuna koymanız, soyadına göre bir metin filtresi eklemeniz yeterli - ve işte, bilgi ekranınızda.
Büyük tabloları filtrelemenin sistem performansını ve sayfa yükleme süresini etkileyebileceğini belirtmekte fayda var, bu nedenle filtreye büyük bir tablo koymak geçici bir engeldir, insanların okunamayan devasa tablolar (bir sürecin örneği makalenin sonunda olacaktır).
Sıralama (ücretli eklenti)
Sihirli Makro ile ayrıca herhangi bir sütunda varsayılan sıralamayı ayarlayabilir ve satırları numaralandırabilirsiniz. Ya da tablonun herhangi bir kolonuna tıklanarak filtre makrosu konur ve bu kolona göre sıralama gerçekleşir.
Örneğin, başvuru sahipleriyle aynı tabloya sahipsiniz ve belirli bir ayda kaç görüşme yapıldığını bulmanız gerekiyor - tarihe göre sıralayın ve sevinin.
Pivot Tablolar (ücretli eklenti)
Şimdi daha ilginç bir duruma geçelim. Masanızın çok büyük olduğunu ve üzerinde bir şeyler hesaplamanız gerektiğini hayal edin. Tabii ki Excel'e kopyalayabilir, neye ihtiyacınız olduğunu hesaplayabilir ve verileri tekrar Confluence'a yükleyebilirsiniz. Bir kez makro uygulayabilir misin? ve aynı sonucu elde edin, yalnızca güncellendi.
Örneğin: tüm çalışanların verilerini içeren bir tablonuz var - coğrafi olarak nerede bulundukları ve hangi pozisyonlarda bulundukları. Her şehirde kaç kişinin olduğunu hesaplamak için, "Özet Tablo" makrosunda verilerin toplandığı satırı (konum) ve işlem türünü (ekleme) seçmeniz gerekir.
Doğal olarak aynı anda birkaç kritere göre gruplandırabilir, tüm olasılıkları görebilirsiniz. .
Grafikler (ücretli eklenti)
Dediğim gibi herkes benim kadar sofraları sevmiyor. Ne yazık ki, çoğu yönetici onlardan hiç hoşlanmıyor. Ancak herkes parlak renkli tabloları sever.
Confluence'ın yaratıcıları bunu kesinlikle biliyorlardı (elbette raporları ve çizelgeleri seven patronları da var, onsuz nerede olurlardı). Bu nedenle, sihirli makroyu kullanabilirsiniz. . Bu makroda, önceki paragraftaki pivot tabloyu koymanız gerekir ve işte - sıkıcı gri verileriniz güzel bir şekilde görselleştirilir.
Doğal olarak bu makronun da ayarları vardır. Herhangi bir makronun belgelerine bir bağlantı, o makronun düzenleme modunda bulunabilir.
toplama kolaylığı
Önceki paragraflardaki bilgiler muhtemelen sizin için bir açıklama değildi. Ama artık makroları nasıl kullanacağınızı kesinlikle biliyorsunuz ve makalenin daha ilginç olan kısmına geçebilirim.
Etiketler
İnsanların bilgileri tek bir yapılandırılmamış makalede veya devasa bir tabloda depolaması kötüdür. Daha da kötüsü, bu bilgilerin bazı bölümlerinin okunamaz olması değil, aynı zamanda Confluence'ın geniş alanlarına dağılmış olması. Neyse ki, dağınık bilgileri tek bir yerde toplamak mümkündür. Bunun için kullanmanız gerekir (sosyal ağlarda herkesin bildiği etiketler).
Herhangi bir sayfaya herhangi bir sayıda etiket eklenebilir. Bir etikete tıklamak, sizi o etikete sahip tüm içeriğin yanı sıra bir dizi ilgili etikete bağlantılar içeren bir toplama sayfasına götürür. İlgili etiketler, aynı sayfada sıklıkla görünen etiketlerdir.
Sayfa özellikleri
Yapılandırma bilgileri için sayfaya başka bir ilginç makro ekleyebilirsiniz - . İçinde iki sütunlu bir tablo göndermeniz gerekiyor, ilki anahtar, ikincisi ise mülkün değeri olacak. Ayrıca makro, içeriğin okunmasını engellememesi için sayfadan gizlenebilir, ancak sayfa yine de gerekli tuşlarla işaretlenecektir.
Kimliğe dikkat edin - farklı özellik gruplarını farklı sayfalara (veya hatta farklı özellik gruplarını bir sayfada) asacak şekilde ayarlamak uygundur.
Raporlar
Etiketlere göre raporlar toplayabilirsiniz. Örneğin, makro belirli bir etiket kümesine sahip tüm sayfaları toplar.
Ancak daha ilginç bir rapor bir makrodur. . Ayrıca, belirli bir etiket kümesine sahip tüm sayfaları toplar, ancak yalnızca listelemekle kalmaz, aynı zamanda bir tablo derler (makalenin başlangıcıyla bağlantıyı yakalıyor musunuz?), Sütunların sayfa özelliklerinin anahtarları olduğu.
Farklı kaynaklardan bir özet bilgi tablosu ortaya çıkıyor. Kullanışlı özelliklere sahip olması güzel: uyarlanabilir düzen, herhangi bir sütuna göre sıralama. Ayrıca, makro içinde böyle bir raporlama tablosu yapılandırılabilir.
Yapılandırırken, rapordan bazı sütunları kaldırabilir, varsayılan durumu veya görüntülenen kayıt sayısını ayarlayabilirsiniz. Sayfa özelliği kimliğini yalnızca ihtiyacınız olan bilgileri görecek şekilde de ayarlayabilirsiniz.
Örneğin, çok sayıda çalışan sayfanız var, bu sayfalarda bir kişi hakkında bir dizi özellik var: hangi seviyede, nerede, ekibe ne zaman katıldı vb. Bu özellikler işaretlenir kimlik = çalışan_inf. Aynı sayfada, bir ekibin parçası olan bir kişi hakkında bilgiler içeren ikinci bir özellik grubu vardır: kişinin hangi rolü yerine getirdiği, hangi takımda olduğu vb. Bu özellikler işaretlenir Kimlik = ekip_inf. Ardından, bir rapor derlerken, aynı anda yalnızca bir veya iki kimlik için bilgi görüntüleyebilirsiniz - hangisi daha uygunsa.
Bu yaklaşımın güzelliği, herkesin ihtiyaç duyduğu bilgi tablosunu toplayabilmesidir, bu tablo hiçbir şeyi tekrar etmeyecektir ve ana sayfa güncellendiğinde güncellenecektir. Örneğin: bir ekip lideri, geliştiricilerinin ne zaman iş bulduğunu umursamaz, ancak her birinin ekipte hangi rolü oynadığı önemlidir. Ekip lideri, ekip hakkında bir rapor toplayacaktır. Ve muhasebeci kimin hangi rolü üstlendiğini umursamıyor, ancak pozisyonlar önemli - pozisyonlar hakkında bir rapor toplayacak. Bu durumda bilgi kaynağı çoğaltılmaz veya aktarılmaz.
Son süreç
Talimat
Böylece, örnek olarak makroları kullanarak Confluence'daki bilgileri güzel bir şekilde yapılandırabilir ve etkili bir şekilde toplayabiliriz. Ancak ideal olarak, yeni bilgilerin hemen yapılandırıldığından ve zaten kullanımda olan tüm toplama mekanizmalarına girdiğinden emin olmanız gerekir.
Burada bir sürü makro ve şablon kurtarmaya gelecek. İnsanların doğru biçimde yeni sayfalar oluşturmasını sağlamak için Şablondan Oluştur makrosunu kullanabilirsiniz. İhtiyacınız olan şablondan yeni bir sayfanın oluşturulduğu sayfaya tıklayarak sayfaya bir düğme ekler. Bu sayede insanların ihtiyacınız olan formatta anında çalışmasını sağlarsınız.
Sayfa oluşturmaya izin verdiğiniz şablonda, önceden ihtiyacınız olan etiketleri, "Sayfa Özellikleri" makrosunu ve özellikler tablosunu eklemeniz gerekir. Ayrıca, sayfayı hangi değerlerle dolduracağınıza ve özellik değerlerine ilişkin talimatlar eklemenizi tavsiye ederim.
Ardından, son işlem şöyle görünecektir:
- Belirli bir bilgi türü için bir şablon oluşturuyorsunuz.
- Bu şablonda, bir makroya etiketler ve sayfa özellikleri ekleyin.
- Herhangi bir uygun yerde, şablondan bir alt sayfanın oluşturulduğu düğmeyi tıklayarak bir kök sayfa oluşturun.
- Potansiyel olarak gerekli bilgileri üretecek olan kullanıcıların kök sayfasından başlayın (istenen şablona göre, düğmeye tıklayarak).
- Şablonda belirttiğiniz etiketler aracılığıyla kendinize sayfanın özellikleri hakkında bir rapor toplayın.
- Sevin: İhtiyacınız olan tüm bilgilere uygun bir biçimde sahipsiniz.
Tuzaklar
Bir kalite mühendisi olarak rahatlıkla söyleyebilirim ki dünyada mükemmel olan hiçbir şey yoktur. İlahi tablolar bile kusurludur. Ve yukarıdaki süreçte tuzaklar var.
- Sayfa özelliklerinin adlarını veya bileşimini değiştirmeye karar verirseniz, verilerinin özet rapora doğru bir şekilde çekilmesi için önceden oluşturulmuş tüm nesneleri güncellemeniz gerekir. Bu üzücü ama bir yandan da sizi bilgi kümenizin "mimarisi" hakkında ayrıntılı düşünmeye zorluyor ki bu çok ilginç bir görev.
- Bilgi tablolarını nasıl dolduracağınıza ve etiketleri nasıl kullanacağınıza dair makul miktarda talimat yazmanız gerekecektir. Ancak öte yandan, bu makaleyi tüm doğru insanlara atabilirsiniz.
Ürün dışı belgelerin saklanmasına bir örnek
Yukarıda açıklanan süreç sayesinde, hemen hemen her türlü bilginin depolanmasını organize edebilirsiniz. Yaklaşımın güzelliği, evrensel olmasıdır: kullanıcılar buna alışınca ortalığı karıştırmayı bırakırlar. Ayrıca büyük (ancak ücretsiz değil) bir artı, çeşitli istatistikleri anında toplama ve üzerine güzel diyagramlar çizme yeteneğidir.
Ekip hakkında bilgi tutma sürecimize bir örnek vereceğim.
Ekipteki her kişi için bir çalışan kartı oluşturmaya karar verdik. Buna göre, her yeni kişinin bu kartı kendisi için oluşturduğu ve tüm kişisel bilgilerini içinde sakladığı bir şablonumuz var.
Gördüğünüz gibi, ayrıntılı bir özellik tablosuna sahibiz ve bu sayfanın nasıl korunacağına dair hemen talimatlarımız var. Etiketlerden bazıları talimatlara göre çalışanların kendileri tarafından yerleştirilir, şablonda yalnızca ana olanlar: kart etiketi çalışan kartı, yön etiketi yön-içerir ve komut etiketi takım-qa.
Sonuç olarak, herkes kendisi için bir kart oluşturduktan sonra, çalışanlarla ilgili bilgileri içeren eksiksiz bir tablo elde edilir. Bu bilgiler farklı noktalarda kullanılabilir. Kaynak yöneticileri kendileri için genel tablolar toplayabilir ve ekip liderleri seçime bir ekip etiketi ekleyerek komut tabloları toplayabilir.
Etiketlere göre farklı özetler görebilirsiniz, örneğin qa-yükseltme planı KG geliştirme için tüm görevler görüntülenecektir. Aynı zamanda, çalışan kartındaki her kişi önemli bir hikayeyi ve kendi gelişim planını tutar - gelişim planları şablonundan iç içe bir sayfa oluşturur.
Sonuç
Herhangi bir belgeyi, bundan utanmayacağınız ve kullanıcıların dayanılmaz bir şekilde incinmeyecekleri şekilde saklayın!
Umarım makale faydalı olur ve dünyanın tüm belgelerinde düzen gelir.
Kaynak: habr.com