✍️💫 نمونه دنیای واقعی: کلودفلر چجوری به مستندات فنی نگاه می‌کنه؟

سلام! مستندنویسی فنی یکی از مغفول‌ترین بخش‌های توسعه نرم‌افزار، خصوصا در ایرانه! همه می‌گن خیلی واجبه و ما خیلی ارج می‌نهیم به مستندات، ولی آخرش همون همه، مشمول ترک واجبات و ارج ننهادن می‌شن! حتی technical write پوزیشن گمنامیه توی لیست مشاغل. حالا اینکه چطور کلودفلر، به عنوان شرکتی که توی ۱۹٪ اینترنت رد پاش دیده می‌شه و درآمد حدود ۱.۳ میلیارد دلاری داره (۲۰۲۳) چجوری به مستندات فنی‌اش نگاه می‌کنه و رویکردش چیه؛ می‌تونه خیلی آموزنده باشه.

🗣️ یه نگاه متفاوت به مستندات
یه روزی حدود ۷ سال پیش توی یکی از استارتاپ‌های اثرگذار ایران، با کلی بحث و استدلال، پوزیشن تکنیکال رایتر رو باز کردم و به سختی تلاش کردم مستندات رو یک محصول از تیم معرفی کنم. ولی ۲-۳ سال پیش خوندم که کلودفلر، خیلی ساختارمند و اصولی، مستندات فنی رو محصول می‌دونن، و حتی ترم PCX یا Product Content Experience خلق کردند. یعنی دقیقاً همونطور که روی محصولاتشون وقت میذارن، برنامه‌ریزی میکنن و بهبودش میدن، با مستنداتشون هم همینطور رفتار میکنن.

❓چرا این رویکرد مهمه؟
خب، فکر کنید شما یه محصول عالی دارید ولی کسی نمیدونه چطور ازش استفاده کنه! اینجاست که مستندات خوب به کمکتون میاد. کلودفلر فهمیده که مستندات خوب میتونه تجربه کاربری رو خیلی بهتر کنه.
یا حتی نسلی از توسعه‌دهنده‌ها محصول خیلی خوبی تولید کردند، به هر دلیلی اون توسعه‌دهنده‌ها نیستند دیگه (مهاجرت، ارتقاء، انتقال به تیم دیگه یا ترک شرکت)؛ تکلیف بعدی‌ها چیه؟ قراره چیو تحویل بگیرن و بهبود بدن؟ چیزی رو که نمی‌شناسن؟!

❓ چطور این کار رو میکنن؟
۱. تیم مخصوص دارن: یه تیم مخصوص به اسم PCX یا Product Content Experience دارن که کارشون اینه که مطمئن بشن مستندات در بهترین کیفیت ممکن هستن.

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

۳. اپن سورس هستن: جالبه بدونید که مستندات کلودفلر اپن سورسه! یعنی هر کسی میتونه توش مشارکت کنه و بهترش کنه.

❓ چرا این روش خوب کار میکنه؟
۱. سرعت بالا: وقتی مستندات رو مثل محصول در نظر میگیرن، میتونن خیلی سریع‌تر آپدیتش کنن
۲. کیفیت بهتر: چون یه تیم مخصوص روش کار میکنه، کیفیت محتوا خیلی بهتره
۳. بازخورد مستقیم: کاربرا میتونن مستقیم بازخورد بدن و مستندات بهتر میشه

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

شاید بد نباشه یه نگاهی به این رویکرد داشته باشید. شاید بشه ازش ایده گرفت و توی پروژه‌هاتون اینجوری نگاه کنید! برخی هزینه‌ها، سرمایه‌گذاری و برخی پیشگیری از شکسته.

📱 ریپازیتوری مستندات کلودفلر
⛏ بخش توسعه‌دهنده‌های کلودفلر
✨ابزار Astro که جدیدا بهش مهاجرت کردن (قبلا روی Hugo بودن)