ویکی داخلی شرکت چیست؟ مستندات تیم را چطور مرتب نگه داریم

ویکی داخلی چیست؟

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

چه چیزهایی ارزش نوشتن دارند؟

• راهنمای شروع کار برای هم‌تیمی تازه: چه ابزارهایی، چه روالی و با چه کسی صحبت کند.
• نیازمندی‌ها و تصمیم‌های محصول، با دلیلشان.
• روال‌هایی که تکرار می‌شوند، مثل انتشار نسخه یا پاسخ به یک نوع درخواست.
• پاسخ پرسش‌هایی که بار سوم از شما پرسیده شد.
• نمونه‌ها و قالب‌ها: قالب تسک، قالب گزارش، قالب جلسه.

ساختار پیشنهادی

ساختار ساده بهتر از ساختار کامل است. برای شروع:

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

ثبت تصمیم‌ها

مهم‌ترین نوع سند برای تیم محصول، تصمیم‌هاست. هر تصمیم را با این چهار بخش کوتاه بنویسید:

• زمینه: چه مشکلی داشتیم؟
• گزینه‌ها: چه راه‌هایی را بررسی کردیم؟
• تصمیم: کدام را انتخاب کردیم؟
• پیامد: این انتخاب چه چیزی را آسان‌تر و چه چیزی را سخت‌تر می‌کند؟

شش ماه بعد، وقتی کسی پرسید «چرا اینطور ساخته‌ایم؟»، جواب فقط یک لینک است.

مستندات چطور کهنه نمی‌شود؟

• برای هر صفحه یک مسئول مشخص باشد.
• مستندات را به کار وصل کنید: وقتی تسکی تمام می‌شود، صفحهٔ مربوط به‌روز شود.
• صفحهٔ بی‌مصرف را حذف کنید؛ مستند کهنه از نبودن مستند بدتر است.
• هر چند ماه یک بار فضاها را مرور کنید.
• تاریخچهٔ نسخه‌ها را نگه دارید تا ویرایش اشتباه قابل‌بازگشت باشد.

در مسیر

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