مرور کلی
این یک صفحه جایگزین است که به شما نشان می‌دهد چگونه از این سایت الگو استفاده کنید.
مرور کلی جایی است که کاربران شما درباره پروژه شما اطلاعات کسب می‌کنند. بسته به اندازه مجموعه مستندات شما، می‌توانید یک صفحه مرور جداگانه داشته باشید (مثل این یکی) یا محتوای مرور خود را در صفحه اصلی مستندات قرار دهید (مثل راهنمای کاربر Docsy).
سعی کنید به این سوالات برای کاربر خود در این صفحه پاسخ دهید:
این چیست؟
پروژه خود را معرفی کنید، از جمله کاری که انجام می‌دهد یا به شما اجازه می‌دهد انجام دهید، چرا باید از آن استفاده کنید، و هدف اصلی آن (و چگونه به آن دست می‌یابد). این باید شبیه به توضیحات README شما باشد، اگرچه می‌توانید در صورت تمایل به جزئیات بیشتری در اینجا بپردازید.
چرا می‌خواهم آن را داشته باشم؟
به کاربران خود کمک کنید بدانند آیا پروژه شما به آن‌ها کمک می‌کند یا نه. اطلاعات مفید می‌تواند شامل موارد زیر باشد:
برای چه خوب است؟: چه نوع مشکلاتی را پروژه شما حل می‌کند؟ مزایای استفاده از آن چیست؟
برای چه خوب نیست؟: به عنوان مثال، شرایطی را ذکر کنید که ممکن است به صورت شهودی مناسب پروژه شما به نظر برسد، اما به دلایلی مناسب نیست. همچنین محدودیت‌های شناخته شده، مشکلات مقیاس‌پذیری، یا هر چیز دیگری که ممکن است به کاربران شما بگوید که پروژه برای آن‌ها نیست را ذکر کنید.
برای چه هنوز خوب نیست؟: هر ویژگی مفیدی که به زودی می‌آید را برجسته کنید.
بعد کجا باید بروم؟
گام‌های بعدی را از مرور کلی به کاربران خود بدهید. به عنوان مثال:
بازخورد
این صفحه به شما کمک کرد؟
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.