خوش آمدید!
من ماشا هستم، به عنوان مهندس تضمین کیفیت در گروه شرکت های Tinkoff کار می کنم. کار QA شامل ارتباط زیادی با افراد مختلف از تیم های مختلف است و من نیز مدیر و مدرس برنامه های آموزشی بودم، بنابراین نقشه ارتباطی من تا حد امکان گسترده بود. و در نقطه‌ای منفجر شدم: فهمیدم که دیگر نمی‌توانم، نمی‌توانم، نمی‌توانم هزاران تن جهنمی جدول و اسناد ناخوانا را پر کنم.
مطمئناً هر یک از شما اکنون آنچه را که من در مورد آن صحبت می کنم تصور کرده اید و عرق سردی به مشام می رسد: لیستی از نام خانوادگی بدون ترتیب حروف الفبا، جدول هایی با صدها ستون با چیدمان درهم و برهم، جدول هایی با هزاران خط که باید انگشت خود را در آنها پاک کنید. روی چرخ ماوس برای نگاه کردن به عنوان، هزاران صفحه از دستورالعمل های بدون شماره، صدها نامه ارسال شده به یکدیگر با داده هایی که نیاز به تجزیه و تحلیل و سیستم بندی دارند و در همان جداول غیرقابل خواندن قرار می گیرند.
و بنابراین، زمانی که کمی خنک شدم، تصمیم گرفتم این مقاله را بنویسم. من در مورد این صحبت خواهم کرد که چگونه می توانید به طور معمول (حتی گاهی اوقات به راحتی) انواع اسناد غیر محصول را نگهداری کنید. امیدوارم که مقاله در شبکه پراکنده شود و سطح جهنم در بخش های مجاور توسعه حداقل کمی کاهش یابد و مردم (از جمله من) کمی خوشحال شوند.
ابزارهای
اسناد و مدارک محصول اغلب در کنار کد نگهداری می شوند، که چیز خوبی است. و اسناد غیر محصول معمولاً در هر جایی ذخیره می شود. اغلب مردم سعی می کنند اطلاعات را از مکان های مختلف به Confluence بیاورند و ما نیز از این قاعده مستثنی نیستیم. پس بقیه داستان درباره اوست.
به طور کلی، Confluence یک موتور ویکی پیشرفته است. این به شما امکان می دهد با داده ها در انواع مختلف نمایش کار کنید: متن با قالب بندی، جداول، نمودارهای مختلف. این یک ابزار بسیار جالب و قدرتمند است، اما اگر طرز پخت آن را بلد نیستید، دوباره اسناد غیرقابل خواندن را خواهید دید. من به شما طرز آشپزی را یاد می دهم!
ماکروها
تقریباً تمام جادوی Confluence حول ماکروها ساخته شده است. ماکروهای زیادی وجود دارد و می توان آنها را با یکدیگر ترکیب کرد. آنها پولی و رایگان هستند، در ادامه نمونه های مختلفی از ماکروها با پیوندهایی به اسناد برای آنها وجود خواهد داشت.
رابط کار با ماکروها تا حد امکان ساده است. برای افزودن یک ماکرو باید روی پلاس کلیک کرده و عنصر مورد نظر را از لیست انتخاب کنید.
اگر ماکرو خودکفا باشد، یعنی نیازی به درج چیز دیگری در داخل خود نداشته باشد، شبیه یک بلوک است.
اگر یک ماکرو برای کار کردن به چیزی درون آن نیاز داشته باشد، شبیه یک جعبه است.
در عین حال، تا زمانی که در هرم شما منطق وجود داشته باشد، می توانید هر تعداد دیگری را که دوست دارید در یک قاب قرار دهید.
هر ماکرو یک پیش نمایش دارد: بلافاصله نشان می دهد که آیا ماکرو را به درستی پر کرده و پیکربندی کرده اید یا خیر.
قالب
علاوه بر ماکروها، یک ابزار مناسب برای از قبل پر کردن محتوا وجود دارد - این یک الگو است.
هنگام ایجاد هر صفحه ای می توان از الگوها استفاده کرد: فقط روی سه نقطه کنار دکمه "ایجاد" کلیک کنید و الگوی مورد نظر را انتخاب کنید.
سپس تمام محتوایی که در قالب وجود دارد به صفحه ایجاد شده اضافه می شود.
هر کسی می‌تواند از قالب‌ها صفحات ایجاد کند، اما فقط کسانی که حق ایجاد یا ویرایش الگوها را دارند می‌توانند صفحات ایجاد کنند. می‌توانید دستورالعمل‌های اضافی درباره نحوه نگهداری صفحه به الگو اضافه کنید.
جادوی جدول
در واقع، من به عنوان یک متخصص، جداول را بسیار دوست دارم و می توانم تقریباً هر اطلاعاتی را در آنها بپیچم (اگرچه این همیشه مؤثر نیست). خود جداول واضح، ساختارمند، مقیاس پذیر، جادویی هستند!
اما حتی چنین موجود شگفت انگیزی مانند یک میز نیز می تواند خراب شود. و می توان آن را با موفقیت استفاده کرد و حتی بهبود داد. بیشتر در مورد آن در زیر.
فیلتر کردن (افزونه پولی)
هر جدول بزرگ غیرقابل خواندن را می توان با استفاده از فیلتر کردن کمی بزرگتر و کمی خواناتر کرد. برای این کار می توانید از یک ماکرو پولی استفاده کنید .
در داخل این ماکرو، شما باید یک میز را تکان دهید (حتی زشت ترین آن ممکن است، نکته اصلی این است که آن را به طور کامل تکان دهید). در ماکرو، می‌توانید ستون‌هایی را برای فیلتر کشویی، فیلتر متنی، عددی و فیلتر تاریخ انتخاب کنید.
فقط تصور کنید که تمام اطلاعات نامزدهای همه مشاغل خالی در یک لیست جدولی ثبت شده است. طبیعتاً مرتب نشده - مردم به ترتیب حروف الفبا به مصاحبه نمی آیند. و باید بدانید که آیا قبلاً با متقاضی خاصی مصاحبه کرده اید یا خیر. شما فقط باید این جهنم را در یک فیلتر ماکرو قرار دهید، یک فیلتر متن با نام خانوادگی اضافه کنید - و voila، اطلاعات روی صفحه نمایش شما هستند.
شایان ذکر است که فیلتر کردن جداول بزرگ می تواند بر عملکرد سیستم و زمان بارگذاری صفحه تأثیر بگذارد، بنابراین قرار دادن یک جدول بزرگ در فیلتر یک عصا موقت است، بهتر است فرآیندی ایجاد شود که در آن افراد مجبور نباشند جداول بزرگ ناخوانا ایجاد کنند. نمونه ای از فرآیند در انتهای مقاله خواهد بود).
مرتب سازی (افزونه پولی)
با ماکرو جادویی همچنین می توانید مرتب سازی پیش فرض را روی هر ستونی تنظیم کنید و ردیف ها را شماره گذاری کنید. یا روی هر ستونی از جدول که در ماکرو فیلتر قرار داده شده کلیک کنید، مرتب سازی بر اساس این ستون انجام می شود.
به عنوان مثال، شما با متقاضیان میز یکسانی دارید و باید بفهمید که چند مصاحبه در یک ماه خاص برگزار شده است - بر اساس تاریخ مرتب کنید و خوشحال باشید.
Pivot Tables (افزونه پولی)
حالا بیایید به یک مورد جالب تر برویم. تصور کنید که میز شما بزرگ است و باید چیزی را روی آن محاسبه کنید. البته، می توانید آن را در اکسل کپی کنید، آنچه را که نیاز دارید محاسبه کنید و داده ها را در Confluence بارگذاری کنید. آیا می توانید یک بار ماکرو اعمال کنید؟ و همان نتیجه را دریافت کنید، فقط به روز شده است.
به عنوان مثال: شما یک جدول دارید که حاوی داده های همه کارمندان است - جایی که آنها از نظر جغرافیایی قرار دارند و چه موقعیت هایی دارند. برای محاسبه تعداد افراد در هر شهر، باید در ماکرو "Pivot Table" ردیفی که داده ها بر اساس آن جمع می شوند (مکان) و نوع عملیات (افزودن) را انتخاب کنید.
طبیعتاً می توانید بر اساس چندین معیار به طور همزمان گروه بندی کنید، می توانید همه احتمالات را ببینید .
نمودارها (افزونه پولی)
همانطور که گفتم، همه به اندازه من میزها را دوست ندارند. متأسفانه اکثر مدیران اصلاً آنها را دوست ندارند. اما همه نمودارهای رنگ روشن را دوست دارند.
سازندگان Confluence مطمئناً از این موضوع می‌دانستند (مطمئناً آنها همچنین رئیس‌هایی دارند که عاشق گزارش‌ها و نمودارها هستند، بدون آن کجا خواهند بود). بنابراین، می توانید از ماکرو جادویی استفاده کنید . در این ماکرو، باید جدول محوری پاراگراف قبلی را قرار دهید و voila - داده های خاکستری خسته کننده شما به زیبایی تجسم می شوند.
طبیعتا این ماکرو تنظیماتی هم دارد. پیوندی به مستندات هر ماکرو را می توان در حالت ویرایش آن ماکرو یافت.
سهولت در تجمع
اطلاعات پاراگراف های قبلی احتمالاً برای شما آشکار نبوده است. اما اکنون قطعاً می دانید که چگونه از ماکروها استفاده کنید و من می توانم به قسمت جالب تر مقاله بروم.
برچسب ها
وقتی افراد اطلاعات را در یک مقاله بدون ساختار یا یک جدول بزرگ ذخیره می کنند، بد است. حتی بدتر از آن زمانی است که بخش‌هایی از این اطلاعات نه تنها قابل خواندن نیستند، بلکه در وسعت Confluence نیز پراکنده هستند. خوشبختانه امکان جمع آوری اطلاعات پراکنده در یک مکان وجود دارد. برای این شما باید استفاده کنید (برچسب های آشنا برای همه در شبکه های اجتماعی).
هر تعداد برچسب را می توان به هر صفحه اضافه کرد. با کلیک بر روی یک برچسب، به یک صفحه تجمیع با پیوندهایی به تمام محتوای دارای آن برچسب و همچنین مجموعه ای از برچسب های مرتبط هدایت می شوید. برچسب های مرتبط آنهایی هستند که اغلب در همان صفحه ظاهر می شوند.
ویژگی های صفحه
شما می توانید یک ماکرو جالب دیگر را برای ساختاردهی اطلاعات به صفحه اضافه کنید - . در داخل آن، باید یک جدول از دو ستون ارسال کنید، اولی کلید، و دومی ارزش ملک است. علاوه بر این، ماکرو را می توان از صفحه پنهان کرد تا در خواندن محتوا اختلال ایجاد نکند، اما صفحه همچنان با کلیدهای لازم علامت گذاری می شود.
به شناسه توجه کنید - تنظیم آن برای آویزان کردن گروه های مختلف ویژگی ها در صفحات مختلف (یا حتی گروه های مختلف خواص در یک صفحه) راحت است.
گزارش
با برچسب ها می توانید گزارش جمع آوری کنید. مثلا ماکرو تمام صفحات را با مجموعه مشخصی از برچسب ها جمع آوری می کند.
اما گزارش جالب تر، یک کلان است . همچنین تمام صفحات را با مجموعه مشخصی از تگ ها جمع آوری می کند، اما فقط آنها را فهرست نمی کند، بلکه جدولی را جمع آوری می کند (آیا ارتباط را با ابتدای مقاله پیدا می کنید؟)، که در آن ستون ها کلیدهای ویژگی های صفحه هستند.
جدول خلاصه ای از اطلاعات از منابع مختلف به دست می آید. خوب است که ویژگی های مناسبی دارد: طرح بندی تطبیقی، مرتب سازی بر اساس هر ستون. همچنین، چنین جدول گزارشی را می توان در داخل ماکرو پیکربندی کرد.
هنگام پیکربندی، می توانید برخی از ستون ها را از گزارش حذف کنید، وضعیت پیش فرض یا تعداد رکوردهای نمایش داده شده را تنظیم کنید. همچنین می‌توانید شناسه ویژگی صفحه را تنظیم کنید تا فقط اطلاعات مورد نیازتان را ببیند.
به عنوان مثال، شما تعداد زیادی صفحات کارمند دارید، این صفحات دارای مجموعه ای از ویژگی ها در مورد یک شخص هستند: او در چه سطحی است، کجاست، چه زمانی به تیم ملحق شد و غیره. این خواص مشخص شده است id = staff_inf. و مجموعه دومی از ویژگی ها در همان صفحه وجود دارد که حاوی اطلاعاتی در مورد یک فرد به عنوان بخشی از یک تیم است: آن شخص چه نقشی دارد، در چه تیمی قرار دارد و غیره. این ویژگی ها مشخص شده اند شناسه = team_inf. سپس، هنگام جمع‌آوری گزارش، می‌توانید تنها اطلاعات یک یا دو شناسه را در یک زمان نمایش دهید - هر کدام راحت‌تر است.
زیبایی این روش این است که همه می توانند جدول اطلاعات مورد نیاز خود را جمع آوری کنند که هیچ چیزی تکراری نمی شود و با به روز رسانی صفحه اصلی به روز می شود. به عنوان مثال: یک رهبر تیم اهمیتی نمی دهد که توسعه دهندگانش چه زمانی شغلی پیدا کردند، بلکه مهم است که هر کدام از آنها چه نقشی در تیم بازی می کنند. رهبر تیم گزارشی از تیم جمع آوری می کند. و حسابدار اهمیتی نمی دهد که چه کسی چه نقشی را انجام می دهد ، اما موقعیت ها مهم هستند - او گزارشی از موقعیت ها جمع آوری می کند. در این صورت منبع اطلاعات کپی و انتقال داده نخواهد شد.
فرآیند نهایی
دستور العمل
بنابراین، می‌توانیم با استفاده از ماکروها به‌عنوان مثال، اطلاعات را در Confluence به زیبایی ساختار و به طور مؤثر جمع‌بندی کنیم. اما در حالت ایده‌آل، باید مطمئن شوید که اطلاعات جدید فوراً ساختار یافته است و در تمام مکانیسم‌های تجمیع در حال استفاده قرار می‌گیرد.
در اینجا دسته ای از ماکروها و الگوها به کمک می آیند. برای ترغیب افراد به ایجاد صفحات جدید با فرمت مناسب، می توانید از ماکرو Create from Template استفاده کنید. دکمه ای را به صفحه اضافه می کند که با کلیک روی آن صفحه جدیدی از قالب مورد نیاز شما ایجاد می شود. به این ترتیب افراد را مجبور می کنید که فوراً در قالب مورد نیاز شما کار کنند.
در قالبی که از آن اجازه ایجاد صفحه را می‌دهید، باید برچسب‌ها، ماکرو «خواص صفحه» و جدولی از ویژگی‌های مورد نیاز خود را از قبل اضافه کنید. همچنین توصیه می‌کنم دستورالعمل‌هایی درباره مقادیر پر کردن صفحه و مقادیر دارایی اضافه کنید.
سپس روند نهایی به صورت زیر خواهد بود:
- شما در حال ایجاد یک الگو برای نوع خاصی از اطلاعات هستید.
- در این الگو، برچسب ها و ویژگی های صفحه را در یک ماکرو اضافه کنید.
- در هر مکان مناسب، یک صفحه ریشه با یک دکمه ایجاد کنید، با کلیک کردن روی آن یک صفحه فرزند از الگو ایجاد می شود.
- راه اندازی در صفحه اصلی کاربرانی که به طور بالقوه اطلاعات لازم را تولید می کنند (با توجه به الگوی مورد نظر، با کلیک بر روی دکمه).
- از طریق تگ هایی که در قالب مشخص کرده اید، گزارشی از ویژگی های صفحه جمع آوری کنید.
- شاد باشید: شما تمام اطلاعات مورد نیاز خود را در قالبی مناسب در اختیار دارید.
مشکلات
به عنوان یک مهندس کیفیت، به جرات می توانم بگویم که هیچ چیز کاملی در دنیا وجود ندارد. حتی سفره های الهی هم ناقص است. و در روند فوق مشکلاتی وجود دارد.
- اگر تصمیم به تغییر نام یا ترکیب ویژگی های صفحه دارید، باید تمام اشیاء ایجاد شده از قبل را به روز کنید تا داده های آنها به درستی در گزارش خلاصه کشیده شود. این ناراحت کننده است، اما از طرف دیگر، شما را مجبور می کند تا در مورد "معماری" مجموعه اطلاعات خود که کار بسیار جالبی است فکر کنید.
- شما باید دستورالعمل های مناسبی در مورد نحوه پر کردن جداول اطلاعات و استفاده از برچسب ها بنویسید. اما، از طرف دیگر، شما می توانید این مقاله را به همه افراد مناسب بیندازید.
نمونه ای از ذخیره اسناد غیر محصول
از طریق فرآیندی که در بالا توضیح داده شد، می توانید ذخیره سازی تقریباً هر اطلاعاتی را سازماندهی کنید. زیبایی این رویکرد این است که جهانی است: وقتی کاربران به آن عادت کنند، از ایجاد آشفتگی دست می‌کشند. همچنین یک مزیت بزرگ (اما نه رایگان) امکان جمع آوری آمارهای مختلف در پرواز و ترسیم نمودارهای زیبا روی آن است.
من نمونه ای از روند خود را برای حفظ اطلاعات تیم ارائه می کنم.
برای هر فرد در تیم تصمیم گرفتیم یک کارت کارمند ایجاد کنیم. بر همین اساس ما قالبی داریم که هر فرد جدید طبق آن این کارت را برای خود می سازد و تمام اطلاعات شخصی خود را در آن نگه می دارد.
همانطور که می بینید، ما یک جدول دقیق از خواص داریم و بلافاصله دستورالعمل هایی در مورد نحوه نگهداری از این صفحه داریم. برخی از برچسب ها طبق دستورالعمل توسط خود کارمندان قرار می گیرند، در قالب فقط موارد اصلی: برچسب کارت کارت کارمند، برچسب جهت جهت-درگیر کردن و تگ فرمان تیم-قا.
در نتیجه پس از اینکه همه برای خود کارتی درست کردند، جدول کاملی با اطلاعات کارمندان به دست می آید. این اطلاعات را می توان در نقاط مختلف مورد استفاده قرار داد. مدیران منابع می‌توانند جداول کلی را برای خود جمع‌آوری کنند، و رهبران تیم می‌توانند با افزودن یک تگ تیم به انتخاب، جداول فرمان را جمع‌آوری کنند.
بر اساس برچسب ها، می توانید خلاصه های مختلفی را مشاهده کنید، به عنوان مثال، توسط qa-upgrade-plan تمام وظایف برای توسعه QA نمایش داده خواهد شد. در همان زمان، هر فرد در کارت کارمند خود یک داستان مهم و برنامه توسعه خود را نگه می دارد - او یک صفحه تودرتو از الگوی برنامه های توسعه ایجاد می کند.
نتیجه
هر مستندی را به گونه ای نگه دارید که از آن خجالت نکشید و کاربران به طرز طاقت فرسایی آسیب نبینند!
من واقعاً امیدوارم که مقاله مفید واقع شود و نظم در تمام اسناد جهان بیاید.
منبع: www.habr.com