🔵 عنوان مقاله
Examples are the best documentation (2 minute read)

🟢 خلاصه مقاله:
**این مقاله می‌گوید آنچه بیشترِ توسعه‌دهندگان از مستندات می‌خواهند، مثال‌های روشن و اجراشدنی است، اما منابع رسمی اغلب با فرض آشنایی عمیق نوشته می‌شوند و مثال کم دارند؛ همین موضوع برای کسانی که بین اکوسیستم‌ها جابه‌جا می‌شوند، مانع یادگیری سریع است. نمونه‌های عینی با نشان‌دادن ورودی/خروجی، الگوهای رایج و خطاهای محتمل، بار ذهنی را کم می‌کنند و از متن خشک مؤثرترند. سایت‌های جامعه‌محور مثل clojuredocs.org ارزش مستندسازی مبتنی بر مثال را نشان می‌دهند: قطعه‌کدهای کوتاه، واقعی و همراه با نکته‌ها یادگیری را سریع و عملی می‌کنند. توصیه نهایی: مثال را رکن اول مستندات بدانید؛ کنار هر مفهوم و API، مثال‌های حداقلی و قابل اجرا بگذارید، مشارکت جامعه را بپذیرید و به محیط‌های تعاملی لینک دهید تا ورود سریع‌تر و خطا کمتر شود.

#Documentation #DeveloperExperience #CodeExamples #TechnicalWriting #OpenSource #ClojureDocs #APIDocs

🟣لینک مقاله:
https://rakhim.exotext.com/examples-are-the-best-documentation?utm_source=tldrdevops

➖➖➖➖➖➖➖➖
👑 @DevOps_Labdon