کتاب Docs for Developers

کتاب Docs for Developers: An Engineer’s Field Guide to Technical Writing (مستندات برای توسعه‌دهندگان: راهنمای میدانی مهندسان برای نگارش فنی) که توسط جمعی از نویسندگان با تجربه از شرکت‌های مطرحی چون گوگل، استرایپ و LaunchDarkly نوشته شده، یک راهنمای عملی برای توسعه‌دهندگان نرم‌افزار و سایر نقش‌های فنی است تا هنر مستندسازی را در کنار کدنویسی بیاموزند.

این کتاب با رویکردی داستان‌گونه و با دنبال کردن یک تیم از توسعه‌دهندگان در فرآیند راه‌اندازی یک محصول جدید، فرآیند مستندسازی را از ابتدا تا انتها آموزش می‌دهد. مباحث کتاب، چرخه‌ی کامل حیات مستندسازی نرم‌افزار را پوشش می‌دهد؛ از درک نیازهای کاربران و انجام تحقیق کاربری، تا طراحی، پیش‌نویس و نگارش انواع مختلف مستندات مانند README، مستندات API، آموزش‌ها و یادداشت‌های انتشار. در نهایت، روش‌های انتشار، اندازه‌گیری موفقیت مستندات از طریق بازخورد و تحلیل‌ها، و همچنین سازماندهی و نگهداری از آن‌ها را نیز پوشش می‌دهد.

این کتاب با ارائه‌ی فرآیندهای گام‌به‌گام، الگوها و بهترین شیوه‌ها، به خوانندگان کمک می‌کند تا مستنداتی مفید و کارآمد ایجاد کنند و باورهای غلطی مثل «نوشتن کار من نیست» را کنار بگذارند و استدلال می‌کند که مستندات خوب به اندازه‌ی کد تمیز اهمیت دارد. این کتاب برای توسعه‌دهندگانی که نیاز به مستندسازی دارند و همچنین برای نویسندگان فنی، مدیران محصول، و مدافعان توسعه‌دهنده (Developer Advocate) منبعی ارزشمند محسوب می‌شود.

در ادامه مقدمه‌ای از کتاب Docs for Developers را از زبان نویسنده شرح خواهیم داد.

مقدمه‌ای بر کتاب Docs for Developers :

هنر مستندسازی را برای هر مرحله از چرخهٔ حیات توسعهٔ نرم‌افزار بیاموزید؛ از درک نیازهای کاربران گرفته تا انتشار، اندازه‌گیری و نگهداری مستندات مفید برای توسعه‌دهندگان.

پروژه‌هایی که مستندات خوبی دارند، هم برای توسعه‌دهندگانِ درگیر در پروژه و هم برای کاربران نرم‌افزار، صرفه‌جویی در زمان ایجاد می‌کنند. در مقابل، پروژه‌های فاقد مستندات کافی از بهره‌وری پایین توسعه‌دهندگان، مقیاس‌پذیری محدود، استقبال کم کاربران و دسترسی‌پذیری ضعیف رنج می‌برند. به‌طور خلاصه: مستندات بد، پروژه را نابود می‌کند. این نسخهٔ جدید به‌طور کامل به‌روزرسانی و ویرایش شده است و نیازهای امروزی توسعه‌دهندگان و نویسندگان فنی را در نظر گرفته و مطالب تازه‌ای دربارهٔ هوش مصنوعی، اتوماسیون و مدل‌های زبانی بزرگ (LLM) به آن افزوده شده است.

کتاب Docs for Developers فرآیند خلق مستندات عالی برای توسعه‌دهندگان را رم‌گشایی می‌کند و داستان تیمی از توسعه‌دهندگان نرم‌افزار را دنبال می‌کند که در تلاش برای عرضهٔ یک محصول جدید هستند. در هر مرحله از این مسیر، شما با استفاده از مثال‌ها، الگوها و اصول کلیدی یاد می‌گیرید که چگونه مستندات را ایجاد، اندازه‌گیری و نگهداری کنید—ابزارهایی که می‌توانید با نیازهای سازمان خود تطبیق دهید.

آنچه یاد خواهید گرفت:

– ایجاد گزارش‌های نقاط درد (friction logs) و انجام تحقیق کاربری برای درک عمیق مشکلات و دلخوری‌های کاربران
– تحقیق، پیش‌نویس‌نویسی و نگارش انواع مختلف مستندات، از جمله فایل‌های README، مستندات API، آموزش‌های گام‌به‌گام (tutorials)، محتوای مفهومی و یادداشت‌های انتشار (release notes)
– انتشار و نگهداری مستندات هم‌زمان با انتشار منظم کد
– اندازه‌گیری موفقیت محتوای تولیدشده از طریق تحلیل داده‌ها (analytics) و بازخورد کاربران
– سازماندهی مجموعه‌های بزرگ‌تر از مستندات تا کاربران بتوانند اطلاعات درست را در زمان مناسب پیدا کنند
– درک این موضوع که در کجای فرآیند مستندسازی می‌توان از هوش مصنوعی استفاده کرد و در کجا نباید از آن استفاده کرد

این کتاب برای چه کسانی است:

توسعه‌دهندگانی که نیاز به مستندسازی در کنار کدنویسی دارند، و همچنین نویسندگان فنی، مدیران محصول، مدیران جامعه، مدافعان توسعه‌دهنده (Developer Advocates) و سایر نقش‌های فنی که در تولید و مشارکت در مستندات نقش دارند.

نقل قول‌ها:

•  «این کتاب مانند «استرانک و وایت» برای نوشتن مستندات فنی است.»
  — تام جانسون، نویسندهٔ فنی ارشد، گوگل
•  «هم‌چنان که هوش مصنوعی نحوهٔ یافتن و مصرف اطلاعات را دگرگون می‌کند، درک کاربران و نوشتن مستنداتی که به آن‌ها خدمت کند، نقشی حیاتی پیدا کرده است – و کتاب Docs for Developers این فرآیند را برای هر تیمی قابل‌دسترس می‌سازد.»
  — تال گلاک، مدافع توسعه‌دهنده، GitBook و نویسندهٔ همکار گزارش State of Docs

سرفصل‌های کتاب Docs for Developers:

• Docs for Developers
• Foreword from the First Edition
• Praise for the Second Edition
• Preface: Second Edition
• Introduction
• Acknowledgments
• Table of Contents
• About the Authors
• 1. Understanding Your Audience
• 2. Planning Your Documentation
• 3. Drafting Documentation
• 4. Editing Documentation
• 5. Integrating Code Samples
• 6. Adding Visual Content
• 7. Publishing Documentation
• 8. Gathering and Integrating Feedback
• 9. Measuring Documentation Quality
• 10. Organizing Documentation
• 11. Maintaining Documentation
• Appendix A: When to Hire an Expert
• Appendix B: AI Documentation
• Appendix C: Additional Resources
• Bibliography
• Index

جهت دانلود کتاب Docs for Developers می‌توانید پس از پرداخت، دریافت کنید.