مستندسازی در تیم – تجربیات

writing

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

راحت گرفتن یا سخت گرفتن

ما به صورت پیشفرض آدم های مستند بنویسی نیستیم. در حقیقت حوصله خوندن هم نداریم چه برسه به نوشتن. همین موضوع باعث می شه موضوع مستندسازی رو راحت یا سخت در تیم بگیریم در یک بازه زمانی یا فراموش بشه یا مشکلات دیگه باهاش بروز کنه.

مستند سازی با چه هدفی؟

هدف از مستندسازی چیه؟ این مستندسازی قرار هست چه مشکلاتی رو حل کنه؟ این سوالات پایه و اساس مستندسازیه. دید ایده آل باعث می شه بخوایم خیلی شیک مثل خارجی ها بشینیم مستند درست کنیم، قبول کنیم، معمولا جواب نمی ده… اگر جواب بده چقدر از اون مستندات استفاده می شه؟

نوع کار

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

چه چیزی را مستند نکنیم؟

من می گم هر چیزی که بشه با یه جستجوی ساده در گوگل بهش رسید.

چه چیزی را مستند کنیم؟

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

چطور مستند کنیم؟

کار رو سخت نکنید. قرار نیست فایل مستند شده شما تماما با جزئیات به زبان فارسی آماده شود. داشتن یک لیست از لینک های مفید و مرتبط هم می تونه کفایت کنه (شرط جستجو در گوگل رو از یاد نبرید). خیلی راحت می توانید برای تکمیل مستند لینک بدید به مقالات مرتبط انگلیسی زبان.

چطوری مستند کنیم؟

روش ها و ابزارها مختلفه. باید ببینید کدوم راه برای تیم و گروه شما مناسبتره. یه اصل اینه که هرچی این فرآیند ساده تر باشه (مشاهده، استفاده، جستجو پذیری، در دسترس پذیر بودن، اضافه کردن و …) احتمال شکست کار کمتر می شه.

خودتون رو محدود نکنید. بطور مثال برای به اشتراک گذاری لینک ها بین گروه می شه از این قابلیت جدید دراپ باکس استفاده کرد. یک روش خوب دیگه که من خیلی وقته ازش استفاده می کنم، نوشتن در وبلاگ هست. بطور مثال نسخه بندی صحیح نرم افزار را ببینید (یا مطالب مربوط به Gulp). این باعث می شه در درجه اول خودتون هیچوقت فراموش نکنید و در درجه دوم علاوه بر اینکه اون مطلب را در اختیار عموم گذاشته اید، تاثیر مثبت تری در تیم دریافت کنید برای انجامش.

پیروی از استانداردها

یک راه خوب برای حل مشکل مستند سازی، استفاده از استانداردهاست. خوشبختانه تقریبا برای هرچیزی چند تا استاندارد وجود داره. پیروی کردن از استانداردها باعث حل مشکلات زیادی می شه. حداقلش اینه که نفر جدید با مطالعه استانداردها می تونه متوجه فرآیند کار بشه. همچنین یک بخش از مستندات هم درج استانداردهای تیم هست. این نمونه جالب رو ببینید.

28826545

چه کسانی قرار هست مستندات را بخوانند؟

برای چه کسی قرار بنویسید. این تاثیر زیادی در نوع نوشتن، وارد شدن به جزئیات و موارد دیگر دارد. پس حتمن مد نظر قرار بدید.

استفاده از ویدئو

ساخت ویدئو معجزه می کنه. معمولا در خیلی از موارد ایجادش زمان خیلی کمتری نسبت به نوشتن می گیره (در صورتی که بلد باشید و سخت نگیرید!) و از اونطرف هم احتمال اینکه شخص مورد نظر اون رو ببینه بیشتر هست. پس در جاهایی که ویدئو می تونه یه گزینه باشه، حتمن بهش فکر کنید.

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

احتمالا در یک نوشته دیگر چند ابزار رو معرفی خواهم کرد. مهمترین مشخصه نوع ابزار جواب دادن برای تیم و گروه شماست. در درجه اول اگر می توانید از سرویس های آشنا مثل Google Docs استفاده کنید. یک نکته مهم دیگر پیوند خوب با دیگر ابزارهایی هست که دارید استفاده می کنید. اگر سیستم مدیریت پروژه شما با سیستم مستندات یکپارچه باشد مطمئنا یک نکته مثبت هست.

51322930

در دسترس پذیری

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

اگر شما هم تجربیات مثبت و منفی در این زمینه دارید، خیلی خوبه که در همینجا اون رو به اشتراک بگذارید یا اگر مطلب خوبی می شناسید نیز لینک آن را قرار دهید.

2 دیدگاه

دیدگاه ها بسته شده است.