در سال 2023، نباید هیچ بحثی در مورد ارزش افزوده اسناد عالی در پروژه های نرم افزاری وجود داشته باشد. مهندسان نرم افزار باید بسته به نوع منبع و زمانی که به آن نیاز دارند به پایگاه دانش مناسب دسترسی داشته باشند. اسناد فنی برای توسعه دهندگان نرم افزار می تواند اشکال مختلفی داشته باشد، از جمله اسناد همیشه سبز (مثلاً رویه های راه اندازی یک پروژه)، اصول معماری که توسعه دهندگان باید در پروژه های خود رعایت کنند، اسناد انتشار، استانداردهای کدگذاری و دستورالعمل ها، راهنماهای سوار شدن، و موارد دیگر.
مستندسازی برای مخاطبان فنی به دلایل بسیاری چالش سختی است: به روز نگه داشتن سازمانی دقیق نیاز دارد. مهندسانی که اغلب از صرف وقت برای نگهداری اسناد بیزارند، به سرعت می توان آن را کنار گذاشت. یکی از اشتباهات رایج این است که همه دسته‌های مستندات را در یک سطح در نظر بگیرید: برای مثال، یک روش همیشه سبز برای نصب نرم‌افزار با استاندارد کدنویسی که به طور منظم تکامل می‌یابد یکسان نیست. شما به این دانش در همان زمان و فرکانس نیاز ندارید. هنگامی که متوجه شدید، می توانید فرآیندها و کانال های مختلفی را برای مدیریت مستندات فنی خود تعریف کنید
در این پست، مروری بر 35 ابزار موجود برای مدیریت دانش فنی ارائه می‌کنیم که می‌توانند در این دسته‌های اصلی پراکنده شوند:
- ابزارهای ویکی مانند جایی که مهندسان مستندات را در UI ابزار می نویسند (مثلاً: Notion، Confluence، …)
- دانش زنده ابزارهایی که در آن دانش از ابزار توسعه‌دهندگان بیرون می‌آید و سپس پویا می‌شود، به عنوان مثال، در تجزیه و تحلیل کد و جلسات نصب (مثلاً Promyze) استفاده می‌شود.
- ارتباط ابزارهایی مانند پلتفرم‌های Questions/Answers (مثلاً StackOverflow برای تیم‌ها، …)
- ویکی تولید شد ابزارهایی که توسعه دهندگان معمولاً اسناد را به صورت علامت گذاری می نویسند و سپس همه جادو اتفاق می افتد (مثلاً ReadTheDocs، …)
این پست ابزارهایی را که ارائه می کنند در نظر نمی گیرد کاربر نهایی اسناد، مانند پورتال های سلف سرویس (Zendesk، Intercom، و غیره). ما بر مستندات ساخته شده توسط توسعه دهندگان برای توسعه دهندگان تمرکز می کنیم. ما همچنین ابزارهای مستندسازی API را که متعلق به دامنه خاصی است که شایسته مقاله آن است، حذف می کنیم.
یادداشت بردارید، مسائل را تجزیه و تحلیل کنید، پیشرفت خود را پیگیری کنید، یک پایگاه دانش ایجاد کنید.
توانمندسازی توسعه دهندگان و تیم ها برای یادگیری، اشتراک گذاری و موفقیت از طریق جوامع آنلاین و به اشتراک گذاری دانش.
متن باز مفهوم جایگزین
مستندات محصول بهتر بسازید – سریعتر
پلتفرم همکاری اسناد نسل بعدی برای تیم ها!
(منبع باز) BookStack یک پلت فرم ساده، خود میزبان و با استفاده آسان برای سازماندهی و ذخیره اطلاعات است.
با پلتفرم بهره وری همه کاره که تیم ها، وظایف و ابزارها را در یک مکان گرد هم می آورد، در زمان صرفه جویی کنید.
سند همه کاره برای تیم ها.
New Relic CodeStream یک افزونه منبع باز رایگان برای VS Code، Visual Studio و JetBrains است.
Confluence فضای کاری تیمی دوستانه از راه دور شما است که در آن دانش و همکاری با یکدیگر ملاقات می کنند.
(OpenSource) ساده ترین راه برای مستندسازی پروژه شما.
پلتفرم همه کاره برای اسناد آنلاین.
(OpenSource) وب سایت های بهینه سازی شده را به سرعت بسازید، روی محتوای خود تمرکز کنید.
(منبع باز) انجمن ها ساده شده اند. مدرن، سریع و رایگان!
(متن باز) Forem یک پلتفرم متن باز برای ایجاد جوامع مدرن، مستقل و ایمن است.
جایی که تیم های نرم افزاری سیلوهای دانش را می شکنند. (ما از آن در Promyze برای اسناد عمومی خود استفاده می کنیم)
وب سایت هایی برای شما و پروژه های شما.
(OpenSource) سریعترین فریمورک جهان برای ساخت وب سایت.
متن ساده خود را به وب سایت ها و وبلاگ های ثابت تبدیل کنید.
مولد سایت ایستا از فایل های Markdown.
(متن باز) مستندات پروژه با Markdown.
فضای کاری یکپارچه – برای وظایف، یادداشت‌ها، ویکی‌ها و تقویم شما.
با استفاده از Notion به‌عنوان CM، در عرض چند دقیقه یک وب‌سایت Docs با امکانات کامل بسازید
یک روش مدرن، ساده و فوق العاده سریع برای همکاری – دانش، اسناد و پروژه ها را در یک مکان گرد هم بیاورید.
ساده ترین راه برای ایجاد یک آنلاین برای شرکت شما.
(متن باز) Read the Docs با ساخت خودکار، نسخه‌سازی و میزبانی اسناد شما، اسناد نرم‌افزار را ساده می‌کند.
(OpenSource) SkyDocs یک سازنده اسناد استاتیک سبک وزن با MarkDown است.
فرهنگ اشتراک دانش را امروز بسازید.
(OpenSource) Sphinx ایجاد مستندات هوشمند و زیبا را آسان می کند.
به اشتراک گذاری دانش و همکاری بدون حواس پرتی.
پلت فرم اسناد ساخته شده برای مهندسان.
پلاگین کد مانند اسناد Spotify برای Backstage.
بهترین راه برای سازماندهی و به اشتراک گذاری دانش با هم تیمی های خود.
(OpenSource) قدرتمندترین و قابل توسعه ترین نرم افزار منبع باز ویکی
دانش توسعه دهندگان را به هم متصل کنید و بهترین شیوه های کدنویسی را به اشتراک بگذارید، که به طور کامل در ابزارهای توسعه دهندگان یکپارچه شده است.
این همه است، مردمی. ما امیدواریم که آن پست یک نمای کلی از چشم انداز فعلی ابزارهای پایگاه دانش برای توسعه دهندگان نرم افزار به شما ارائه دهد.
در میان موارد ذکر شده در بالا، در Promyze، ما از Notion برای جمع‌آوری مطالبی مانند رویه‌ها برای ایجاد نسخه‌های جدید پسوندهای IDE خود استفاده می‌کنیم. ما از GitBook برای انتشار اسناد کاربری پلتفرم خود استفاده می کنیم. در نهایت، ما از ابزار Promyze خود به صورت داخلی برای ارتقای مداوم استانداردهای کدنویسی جدید استفاده می کنیم. ما این استانداردها را مستقیماً در IDEها و در خلال بررسی کدها آورده ایم زیرا فکر می کنیم این لحظه ای است که توسعه دهندگان به این دانش نیاز دارند. شما با ویکی باز شده در یک برگه کد نمی نویسید.
برای هر نوع مستندسازی، باید مشخص کنید که چه کسی باید آن را به روز کند، چه زمانی و چگونه مهندسین دیگر از این تغییر مطلع خواهند شد.
