مستندسازی در تیم – ابزارها

حدود دو ماه پیش مطلبی در رابطه با تجربیات در مستندسازی در تیم نوشتم که می‌توانید اینجا مطالعه کنید.

اما جایگاه ابزارها کجاست؟ اگر مطلب قبلی را نخواندید پیشنهاد می‌کنم قبل از این نوشته آنرا مطالعه کنید. یک ابزار خوب معیارهایی دارد نظیر:

  • سادگی
  • در دسترس پذیری
  • ساختار اطلاعاتی مناسب

البته فاکتورهای مختلفی در این زمینه اهمیت دارد، نظیر اندازه پروژه، کسانی که قرار هست به مستندها دسترسی داشته باشند و حجم مستندات.

Google Sites

afa-wiki

این گزینه مورد علاقه من هست. چراکه با سرویس‌های آشنایی مانند Google Docs و Google Spreadsheets می‌توانید محتوای خود را ایجاد و مدیریت کنید، همه جا در دسترس است و امکانات لازم نظیر Revision / دسته بندی / تعریف دسترسی را نیز دارد.

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

Static Generatorها نظیر Jekyll

logo-2x

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

CMS نظیر وردپرس

wordpress

این دست شما را بازتر می‌گذارد تا تغییراتی که می‌خواهید بدهید را ایجاد کنید چه در قسمت ورود محتوا چه خروجی و ساختار آن. برای خیلی از CMSهای متن باز نظیر وردپرس، افزونه‌هایی نیز برای راحتتر کردن این فرآیند نیز ایجاد شده است.

Evernote

Web-Evernote-Tutorial

جایی که صحبت از کار با محتوا می‌آید، Evernote به علت ساختار بسیار قدرتمند برای ایجاد یک ساختار محتوایی مناسب، جستجوی قدرتمند و در دسترس پذیریش، همواره یک گزینه مناسب است. می‌توانید یک Notebook ایجاد کرده و آنرا با دیگران به اشتراک بگذارید. بزرگترین مشکل Evernote عدم پشتیبانی از قابلیت راست به چپ است.

دیگر سرویس‌های موجود

برای این مشکل هم یکسری سرویس وجود دارد (اگر گزینه خوبی می‌شناسید معرفی کنید) که می‌توانید از آنها استفاده کنید. هماهنگی بین بخش مستندات و سیستم مدیریت پروژه نیز از نکات مهمی است که بهتر است در نظر داشته باشید.