شهریار بیات
شهریار بیات
خواندن ۵ دقیقه·۲ ماه پیش

بررسی confluence برای تیم های نرم افزاری

بررسی confluence برای تیم های نرم افزاری
بررسی confluence برای تیم های نرم افزاری


ابزار داکیومنت نویسی Confluence یه ابزار فوق‌العاده برای داکیومنت‌کردن و مدیریت دانش توی تیم‌های فنی و مهندسی نرم‌افزاره. به تیم‌ها کمک می‌کنه که دانش و اطلاعاتشون رو به صورت متمرکز جمع‌آوری و به اشتراک بذارن. confluence به تیم‌های برنامه‌نویسی، DevOps و مدیریت پروژه اجازه می‌ده که تسک‌ها، فیچرها، مستندات پروژه و حتی جلساتشون رو به صورت سازمان‌دهی‌شده توی یه فضای مشترک داشته باشن. یه جورایی میشه گفت، همون Google Doc، ولی مخصوص تیم‌های فنی و بزرگ‌تر.

چرا Confluence آره و چرا Google Docs نه؟

درسته، Google Docs یه ابزار عالی برای نوشتن و به اشتراک‌گذاریه، ولی وقتی بحث به کار تیمی و پروژه‌های نرم‌افزاری برسه، Confluence خیلی جلوتره. Google Docs معمولاً برای کارهای سبک‌تر و تیم‌های کوچیک‌تر استفاده می‌شه، ولی Confluence امکانات بیشتری داره. مثلا قابلیت ایجاد صفحه‌های درختی داره که بهت کمک می‌کنه کل داکیومنت‌ها و اطلاعات تیم رو به صورت مرتب و سازمان‌یافته ذخیره کنی. هر تغییری هم که داده بشه، همه اعضای تیم می‌تونن به راحتی دنبال کنن و تاریخچه تغییرات رو ببینن.

یکی دیگه از رقبای اصلی ، Notion هست که بعضی‌ها دوست دارن ازش استفاده کنن. Notion خیلی خوشگل و کاربرپسنده و برای نوشتن نوت‌ها و داکیومنت‌های سریع عالیه. ولی وقتی کار تیمی و پروژه‌های بزرگ می‌شه، Confluence بیشتر به درد تیم‌های فنی می‌خوره چون از سیستم‌ها و ابزارهای فنی بهتر پشتیبانی می‌کنه.

چرا تیم‌های فنی باید از Confluence استفاده کنن؟

وقتی تو یه تیم فنی کار می‌کنی، با چالش‌های پیچیده‌ای مواجه می‌شی. حالا فرض کن یه DevOps یا برنامه‌نویس دیگه بعد از تو قراره با سیستم کار کنه. اگه دقیقاً ندونه که تو چیکار کردی، کلی زمان باید بزاره که سردربیار چی به چی بوده. به همین خاطره که مستندسازی، مخصوصا تو تیم‌های فنی و DevOps خیلی مهمه.

بهترین روش برای استفاده از Confluence اینه که هر بار یه فیچر یا تسک جدید انجام می‌دی، بیای دقیق توضیح بدی چی شده. مثلا اگه به عنوان یه برنامه‌نویس داری یه ماژول جدید اضافه می‌کنی یا توی سیستم لاجیک خاصی رو تغییر می‌دی، همه چی رو به‌وضوح تو Confluence مستند کنی. از جزئیات ریز مثل نوع دیتابیس یا زبان برنامه‌نویسی استفاده‌شده گرفته تا چالش‌هایی که داشتی و راه‌حل‌هایی که براش پیدا کردی. اینطوری نفرات بعدی به‌راحتی می‌تونن مستندات رو بخونن و متوجه بشن باید چی‌کار کنن.

حالا DevOps ها که قضیه‌شون حتی حساس‌تره. اونا معمولاً با کانفیگ‌های پیچیده، سرورها و دیپلوی‌های سنگین سروکار دارن. اگه یکی از کارای DevOps درست مستند نشه و نفر بعدی نتونه باهاش کار کنه، ممکنه کل سرویس به مشکل بخوره. بهترین راه اینه که DevOps‌ ها هم داکیومنت‌های کانفیگ، پروسه دیپلوی، ابزارهای CI/CD و هر کاری که مربوط به نگهداری سیستم میشه رو تو Confluence بنویسن.

بهترین روش مستندسازی توی Confluence چیه؟

برای اینکه از Confluence بهترین استفاده رو ببری، می‌تونی این مراحل دنبال کنی:

اول برای هر پروژه یه صفحه مستقل بساز و زیرشاخه‌های مرتبط رو به صورت درختی بهش اضافه کن. مثلاً می‌تونی یه صفحه برای پروژه X درست کنی و زیرش صفحه‌های مربوط به دیتابیس، بک‌اند، فرانت‌اند، و دیپلوی رو قرار بدی.

هر فیچری که انجام می‌دی یا هر تسکی که به تیم محول می‌شه رو دقیق مستند کن. بگو چرا این کار انجام شده، چه چالش‌هایی داشته و چطور حلش کردی.

برای DevOps ها، باید همه تنظیمات سرور، کانفیگ‌های داکر، CI/CD و هر چیزی که مربوط به زیرساخت‌هاست رو بنویسی.

اگه تصمیم مهمی برای معماری یا توسعه سیستم گرفته شده، حتماً اون رو مستند کن که نفرات بعدی بدونن چرا این تصمیم گرفته شده و چه گزینه‌هایی مد نظر بوده.

مستندات باید به‌روز باشه. هر تغییری که توی پروژه یا کانفیگ‌ها ایجاد می‌شه رو بیایید تو Confluence بنویسید. این کار به همه اعضای تیم کمک می‌کنه تا همیشه با آخرین وضعیت آشنا باشن.

بریم ببینیم ویژگی‌های کلیدی Confluence چیه؟

سیستم جستجوی خیلی راحت و سریعی داره و به سادگی می‌تونید مستندات و اطلاعات مورد نیازتون رو داخلش پیدا کنین.

ارتباط مستقیم با ابزار مدیریت تسک‌ها و پروژه‌ها مثل جیرا، به تیم‌های فنی کمک می‌کنه تا مستندات و تسک‌ها رو به هم متصل کنند.

می‌تونید به سادگی برای هر داکیومنت دسترسی‌های مختلف تعریف کنید.

اعضای تیم می‌تونن به صورت همزمان روی یک داکیومنت کار کنند و تغییرات رو به صورت لحظه‌ای مشاهده کنند.

می‌تونید تمام تغییرات هر داکیومنت رو به همراه نویسنده‌ش ببینید و نسخه‌های قبلی رو بازیابی کنید.

بهترین روش استفاده از Confluence اینه که هر تیم فنی، مخصوصاً برنامه‌نویسان و دواپس‌ها، به صورت منظم داکیومنت‌های مربوط به فیچرها، باگ‌ها و تغییرات رو ثبت کنند. به عنوان مثال، وقتی روی فیچری کار می‌کنید، مراحل پیچیده پیاده‌سازی و چالش‌هایی که برخوردید رو به دقت مستند کنید. این کار کمک می‌کنه تا افراد جدیدی که به تیم اضافه میشن یا نفرات دیگه در آینده، بدون سردرگمی بتونن با سیستم کار کنند.

بریم یه مثال عملی هم ازش بزنیم.

فرض کنید تیم دواپس در حال تنظیم CI/CD هست. تمام مراحل تنظیمات، ابزارهایی که استفاده شده و حتی خطاهایی که ممکنه بهشون برخورد بشه، باید مستند بشه تا همکاران بعدی بدونند از کجا شروع کنند و کدوم راه‌حل‌ها بهترین کارایی رو داشته.

زیر پوست Confluence چیه و چطور همه‌چی رو مدیریت می‌کنه؟

وقتی می‌گیم "کشف خودکار" یعنی دیگه نیازی نیست دونه‌دونه مستندات رو مدیریت کنی یا نگران بشی که چی کجاست. Confluence به‌صورت خودکار تغییرات رو ردگیری می‌کنه و تاریخچه همه صفحات رو ذخیره می‌کنه. اینطوری حتی اگه چیزی رو اشتباه پاک کنی یا تغییری بدی که به درد نمی‌خوره، می‌تونی برگردی به نسخه قبلی.

از طرفی Confluence می‌تونه به Jira، Bitbucket و ابزارهای دیگه هم وصل بشه. مثلاً می‌تونی تسک‌های Jira رو به مستندات Confluence لینک بدی که اعضای تیم بدونن هر کاری چه زمانی و چطور انجام شده.

نتیجه‌گیری

اگه توی تیم فنی کار می‌کنی، چه برنامه‌نویس باشی چه DevOps، استفاده از Confluence می‌تونه به تیم و پروژه‌هاتون کلی کمک کنه. مستندسازی دقیق، به‌روز و منظم باعث می‌شه همه اعضای تیم همیشه به اطلاعات لازم دسترسی داشته باشن و پروژه‌ها سریع‌تر و بهتر پیش بره. Confluence بهترین ابزار برای این کاره چون هم ساده‌ست و هم قدرت بالایی داره و با ابزارهای دیگه هم به‌راحتی یکپارچه میشه.

تیم فنیکار تیمیconfluence تیم‌هایconfluenceداکیومنت نویسی
شهریار بیات هستم برنامه نویس مهندس نرم افزار و مدیر فنی پلتفرم هومسا علاقه مند به تکنولوزی های روز و مباحث مرتبط به SRE و devops اینجا تجربیاتمو باهاتون به اشتراک میزارم
شاید از این پست‌ها خوشتان بیاید