قاعده مستندسازی (Documented) در طراحی سایت

قاعده مستندسازی (Documented) در طراحی سایت

۱۴ شهریور ۱۴۰۰

قاعده مهم بعدی از سری اصول مهم در طراحی سایت، قاعده مستند سازی است. این قاعده بدین معناست که تمامی المان‌های طراحی سایت، برای بقیه افراد و یا برای توسعه پروژه در آینده، مستند شده باشد.

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

بهترین راه برای مستندسازی ایجاد یک راهنما زنده (Live) استایل دهی است، مثل نوشتن کامنت‌ها داخل کد. ولی اگر نمی‌توانید از این نوع راهنما استفاده کنید، ایجاد دستی آن در کد HTML یا حتی به فرمت pdf هم مناسب است. نکته مهمی که باید به خاطر داشته باشید این است که هر آنچه انجام می‌دهید، باید نوشته شود.

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

• چگونه می توانم به فرد دیگری بگویم که چطور از کد من استفاده کند؟
• اگر فردی به تیم اضافه شد، چه چیزهایی را باید برای او توضیح دهم تا بدان چگونه از آن‌ها استفاده کند؟
• چه مواردی از یک ویجت را ارائه کنم تا تمام راه‌هایی که می‌توان از آن استفاده کرد را نشان دهم؟

اصول طراحی سایت

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


برخی از پروژه‌ها
صنعت ساختمان
وال اسپید

وال اسپید تولیدکننده نسل جدید دیوارهای غیر باربر با تکنولوژی کشور سوئیس است که امروز به طور گسترده در ساختمان سازی مدرن از آن استفاده می گردد.

موسسه خیریه
ایپا

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

پروژه‌های بیشتر