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

اینکه یه دیزاین سیستم یه داکیومنت یا مستندات خوب داشته باشه یکی از مهم ترین بخش هاشه، اصلا از نظر من این داکیومنته که یه دیزاین سیستم رو دیزاین سیستم میکنه. تجربه کلی من در مورد داکیومنت دیزاین سیستم ها، مخصوصا دیزاین سیستم های داخل و ایرانی، اینطور بوده که معمولا یا کلا داکیومنتی در کار نیست یا اینکه شدیدا محدود بهش پرداختن. یه داکیومنتیشن خوب باعث میشه تا آدم های مختلف هم بتونن راحت تر از دیزاین سیستم استفاده کنن و هم درک بهتری از تصمیم های شما داشته باشن.اما بدترین نکته در مورد داکیومنت ها اینه که معمولا آدم ها اون رو به عنوان یه هدف در حال حرکت نمیبینن، معمولا این شکلی میبنن که یکبار نوشته میشن و تمام، دیگه قرار نیست باهاش کاری داشته باشیم. داکیومنت دیزاین سیستم یه موضوع همیشه در حال پیشرفته، شما مینویسید و به مرور از اون نگهداری میکنید و استاندارد ها، نکات و دستورالعمل هارو آپدیت میکنید.۱- نویسنده - با یه اینکاره شریک بشیدشاید عجیب به نظر برسه اینکه چقدر نوع نوشتن قراره تاثیر گذار باشه، اما خب واقعیت اینه که اگه شما یه یوایکس رایتر (UX writer) یا یه استراتژیست محتوا (content strategist) نیستید، خوندن این مقاله هم شمارو تبدیل بهش نمیکنه. نکته هایی که جلو تر باهم پیش میریم و میخونیم به ایجاد یه پایه ی بهتر برای ساخت یه چشم انداز درست کمک میکنه، اما خب بیشتر نکته هایی که باهم در موردش صبحت میکنم به نوشتن مربوط میشه و قطعا کسی که توی این زمینه متخصص باشه میتونه شدید بهتون کمک کنه. پس پیشنهاد میدم با یه اینکاره شریک بشید و از کسی کارش نوشتنه کمک بگیرید.۲- کوتاه نویسی - داستان هزار و یک شبوقت طلاست و داکیومنیشن ما قرار نیست این طلا رو از مردم بگیره، بلکه قراره بهشون زمان بیشتری بده. تقریبا تمام کسایی که داکیومنت دیزاین سیستم رو میخونن برای این اومدن که جواب سوالشون رو بگیرن و مسئله شون حل بشه، ما نیومدیم تا داستان هزار و یک شب بخونیم.به نظرم مهم ترین سوالی که که موقع نوشتن داکیومنت باید بپرسید اینه که: از این کوتاه تر هم میشه نوشت؟سناریوی مشابه - شبیه اش رو نشون بدیداگر دیدید که دائم دارید تلاش میکنید که زمینه، سناریو یا توضیحات اضافه بدید، از خود بپرسید: اگه یه مثال بذارم اینجا، بهتر کار نمیکنه؟ این به خواننده ها یه مدل مشابه تو سناریو های مشابه رو نشون میده در نتیجه درک بهتری از اتفاقی که داره میوفته بدست میارن و جواب سوالشون رو راحت تر میگیرن.متن های طولانی رو به یه لیست تبدیل کنیدمتن های طولانی خیلی ترسناکن، جدای ترسناک بودن، معمولا چون آدم ها دارن تلاش میکنن سریع بخونن، یه بخش هایی از متن رو از دست میدن و متوجه منظورش نمیشن. با قالب‌بندی کردن متن های طولانه به یه لیست فهرستی، قابلیت اسکن کردن آدم هارو افزایش بدید.تقریبا همه خواننده ها اومدن تو داکیومنت و دنبال جهت و رویکرد دیزاین سیستم میگردن. جمله های دستوری یا مطلق اصلا راه خوبی برای دادن دیتای واضح نیست. پس سعی کنید جمله رو کوتاه کنید و خیلی زود تکلیف رو روشن کنید، بدون دستور دادن.۳- رویکرد - همینی که هست!البته تو بند اخر بخش قبلی هم راجبش صحبت کردیم، به جز مورد های نادر، از گفتن قانون ها یا دستورالعمل ها به شکل مطلق خودداری کنید.اینکه به آدم ها بگید هرگز یا همیشه کاری را انجام بده، حرکت شدیدا ریسکی و سختیه که بشه اون رو با اطمینان مطلق گفت.احتمال اینکه تو هر قاعده ای استثنا وجود داشته باشه زیاده و شما نمیتونید همیشه همه چی رو پیش بینی کنید، اینکه شما همه چیز رو مطلق و بسته کنید دو تا مشکل ایجاد میکنه:۱- این یه فرهنگ تفکر طراحی سفت و سخت رو تو دیزاین سیستسم ایجاد میکنه. در نتیجه تمرکز آدم ها روی این میره که فقط از قانون ها پیروی کنن و براشون مهم نیست که برای تجربه محصول چه اتفاقی میوفته. ۲- از یه نقطه به بعد آدم ها توی داکیومنت ها دنبال حفره میگردن. هر بار که یه استثنا از قاعده مطلق دیزاین سیستم پیدا میشه، به یکپارچگی داکیومنت ها لطمه می زنه. بدتر از اون، این میتونه باعث این بشه که قوانین غیرقابل مذاکره به نظر بیان و کسی جرات اینکه در موردش حرف بزنه رو نداشته باشه.درخواست قضاوت خوانندهدیزاین سیستم قراره کمک کننده و قدرتمند باشه نه اینکه اقتدار خودش رو به رخ بقیه بکشه. یه داکیومنت همراه با منطق خیلی بهتر از قانون های سفت و سخت بدون زمینه اس. شروع جمله هارو با "بهتر است..." یا "در نظر بگیرید..." و... شروع کنید. همون کارو انجام میده اما دیگه اون احساس بی منطق بودن و سلطه گری رو نمیده.نکته: آوردن دستور عمل ها و دلیل های بیش از حد ممکنه باعث بشه که برای خواننده ها داکیومنت طولانی و ترسناک به نظر برسه. از اون طرف خیلی کوتاه بودن هم این حس رو میده که دارن از یه کتابچه راهنمای دستورالعمل پیروی می کنن و خیلی اهمیتی بهش نمیدن. پیدا کردن تعادل بین این دوتا همیشه کار سختیه.۴- باید ها - بودن یا نبودن؟ مسئله این استبه جای تمرکز روی نقطه های منفی، روی نقطه های مثبت تمرکز کنید. اینکه توی داکیومنت دیزاین سیستم پشت سر هم هی بگید اینکارو نکن، اون کارو نکن، حالت تدافعی توی خواننده ها که عموما هم احتمالا دیزاینر ها هستن، ایجاد میکنه. پس به جای اینکه پشت سر هم بگید اینکارو نکن، توضیح بدید که چیکار باید کرد.نکته: دلیل های زیاد و حتی ضروری وجود داره که توصیه به انجام ندادن کاری بکنید. نکته اصلی موردی که راجبش صحبت کردیم اینه که مراقب باشید که بین بودن و نبودن تعادل ایجاد کنید و خیلی یک طرفه فقط در مورد نباید ها صحبت نکنید، چون در نهایت باعث میشه تا خواننده ها حالت تدافعی به داکیومنت بگیرن.جایگزین ها - پس چیکار کنم؟وقتی که از مثال های منفی برای نشون دادن یه نکته استفاده میکنید، یه جایگزین خوب هم براش معرفی کنید. با این مسیر به جای اینکه خواننده هارو سمت یه بن‌ بست ببرید، برای اونا راه‌ حل ارائه میدید. ۵- تیترها - تکلیف رو روشن کنیدبالا تر در مورد خلاصه نویسی صحبت کردیم، اما باید حواسمون باشه که از اون ور بوم نیوفتیم، از تیتر های مشخص و گویا استفاده کنید و از طرفی سعی کنید کلماتتون دو پهلو نباشه، تا خواننده برداشت های متفاوت نداشته نکنه. اگه بخوام خیلی کلی و خلاصه بگم، هر چی بتونید صریح تر باشید، بهتره. یادتون باشه، هر سرفصل یه هدف دارهتوی بسیاری از وب سایت هایی که یه داکیومنت ارائه میدن، سرفصل ها نقش عملی و سلسله مراتبی دارن، اما این یعنی چی؟ سرفصل ها تو URL استفاده میشن تا خواننده ها بتونن آدرس بخش خاصی از صفحه رو برای افراد دیگه بفرستن.این یعنی اینکه که همه سرفصل‌ها توی URL به خواننده قبل از باز کردن صفحه این ایده رو میده که توی داکیومنت قراره راجب چه چیزی بخونه. این مورد هر چقدر واضح تر باشه، کل سایت قابل اشتراک گذاری و در دسترس تر میشه. البته که این مورد به غیر از اشتراک گذاری، سلسله مراتب صفحه و سئو رو هم بهبود میده. جمع بندی - هزینه نگه داشتن رو یادت نرهتو انتهای صحبت، سه نکته خیلی مهم که میتونید به عنوان یه چک لیست هم بهش نگاه کنید رو میگم، البته معمولا افراد کمی بهش توجه میکنن. نوشتن داکیومنت سخته اما حفظ کردن چیزی که نوشتید به مراتب سخت تره.اضافه کردن محتوا آسونه، اما بیرون آوردن سخته. و در نهایت حتی موفق ترین دیزاین سیستم ها هم محدودیت هایی دارن. پس خیلی به خودتون سخت نگیرید.منابع:Writing more effective design system documentation | by Ross Moody | UX Collective (uxdesign.cc)