فراتر از رنگ و بوردر: چطور پلاسما مستندسازی دیزاین سیستم را متحول کرد
بیشتر دیزاین سیستمها شکست میخورند نه به خاطر کامپوننتهای بد، بلکه چون مستنداتشان آنقدر خستهکننده است که هیچ برنامهنویسی حوصله خواندنشان را ندارد؛ اندرو کالدول چطور پلاسما را مثل یک محصول مستقل مستند کرد؟

- ناشر منبع
- Andrew Couldwell on Medium
- زمان مطالعه
- ۶ دقیقه مطالعه
- نویسنده منبع
- Andrew Couldwell
- تاریخ انتشار منبع
- ۱۹ آبان ۱۳۹۵
ماجرا از کجا شروع شد؟
اندرو کالدول به عنوان طراح ارشد در WeWork و استودیوی Owl Studios، با واقعیتی تلخ روبرو شد که گریبانگیر اکثر شرکتهای بزرگ فناوری است: تیم طراحی ماهها وقت میگذاشت، صدها کامپوننت عالی در اسکچ و فیگما میساخت، یک PDF صد صفحهای تدوین میکرد، اما شش ماه بعد وقتی به محصول نهایی نگاه میکردید، پر از تناقض بود!
چرا؟ چون هیچ توسعهدهندهای وقت نداشت یک فایل PDF طولانی را ورق بزند تا بفهمد پدینگ یک اینپوت ۱۲ پیکسل است یا ۱۶ پیکسل. مستندسازی دیزاین سیستم شبیه کتابچههای خاکگرفته لوازم خانگی بود که هیچکس بازشان نمیکرد.
چه تصمیمی گرفتند؟
کالدول سیستم طراحی Plasma را با رویکرد «مستندات به عنوان محصول» مهندسی کرد:
- سایت مستندات زنده و تعاملی (Live Sandbox): هر کامپوننت در مرورگر رندر میشد و دولوپر میتوانست وضعیتهای مختلف را با اسلایدر تغییر دهد و کد واقعی CSS/HTML آن را با یک کلیک کپی کند.
- چرایی در کنار چگونگی (The Why Behind the What): به جای گفتن «فاصله دکمهها باید ۸ پیکسل باشد»، توضیح داده شد که «چرا فاصله نزدیکتر به چشم کاربر میگوید این دو عمل به هم مرتبط هستند». این کار به توسعهدهنده درک شهودی از دیزاین میداد.
- راهنمای کارهایی که نباید کرد (Do's and Don'ts): نشان دادن مثالهای عینی با علامت ضربدر قرمز از اشتباهات رایج (مثل استفاده از دکمه قرمز برای کارهای غیرمخرب).
تیم متوجه شد که نوشتن لحن و دستورالعملها یک تخصص مستقل است. آنها یک کپیرایتر فنی استخدام کردند تا ادبیات مستندات پلاسما مثل صحبت با یک همکار شوخطبع و دلسوز باشد، نه شبیه کتابچه قوانین سربازی!
چی شد که جواب داد؟
پلاسما به یکی از تحسینشدهترین سیستمهای طراحی وب تبدیل شد و بعداً به انتشار کتاب مرجع اندرو کالدول به نام Laying the Foundations انجامید که تا امروز یکی از کتب مقدس دیزاین سیستمها در دنیاست.
درس محصولی برای تیمهای سیستم و پلتفرم
ارزش یک سیستم به کامپوننتهای آن نیست، به میزان استفاده درست از آن است. اگر مستندات شما به آسانی باز کردن یک سرچ نباشد و انگیزه خواندن ایجاد نکند، سیستم شما در روز لانچ خواهد مرد.
نسخه کامل و اصلی این کیساستادی
این روایت یک بازخوانی کوتاه فارسی است. برای جزئیات کامل، تصاویر اصلی و متن نویسنده به منبع مراجعه کنید.
کیسهای مرتبط
داستانهای دیگری با موضوع یا برچسبهای نزدیک که شاید الهامبخش باشند.
جادوی بیس کامپوننتها در فیگما: چطور با یک تغییر، هزار کامپوننت بهروز شدند
راهنمای معماری مقیاسپذیر در فیگما: استفاده از کامپوننتهای پایه برای مهار تکثیر لایهها، مدیریت واریانتها و ارتقای عملکرد فایلها.
چطور یک دیزاین سیستم نجاتبخش کدهای آشفته نرمافزارهای سازمانی شد
داستان ایجاد سیستم طراحی Space: متحد کردن جدولهای شلوغ سازمانی، فرمهای چندمرحلهای و تعاملات دسکتاپ زیر یک چتر هماهنگ.
چطور پستمن هزارتوی میلیونها کالکشن را با یک سرچ دوباره مرتب کرد
روایت بازطراحی موتور جستوجو و کشف ریسورس در پستمن: از سردرگمی بین کالکشنهای تکراری تا دستهبندی هوشمند اندپوینتها.


