کتاب Technical Writing for Software Developers: Enhance communication, improve collaboration, and leverage AI tools for software development (نگارش فنی برای توسعه دهندگان نرم افزار: بهبود ارتباطات، بهبود همکاری و استفاده از ابزارهای هوش مصنوعی برای توسعه نرم افزار) شما را با بینش‌های ارزشمندی در مورد فرآیند نوشتن و بازخورد برای اطمینان از بهبود مستمر مجهز می‌کند.
علاوه بر این، نگاهی به روندها و فناوری‌های نوظهور، از جمله ابزارهای هوش مصنوعی، که آینده نگارش فنی را شکل می‌دهند، بیندازید. در پایان کتاب Technical Writing for Software Developers نگارش فنی، شما تخصص لازم را برای رسیدگی مؤثر به درخواست‌های مستندسازی، مجهز به دانش بهترین رویکرد برای مستندسازی هر موضوع، شامل متن، عناصر رسانه، ساختار و ابزارهای مناسب، ایجاد خواهید کرد. مهارت‌های به‌دست‌آمده شما را قادر می‌سازد تا به کار گروهی یکپارچه، افزایش کارایی پروژه و توسعه نرم‌افزار موفق برسید.
در ادامه مقدمه‌ای از کتاب Technical Writing for Software Developers را از زبان نویسنده شرح خواهیم داد.
مقدمه‌ای بر کتاب Technical Writing for Software Developers:
مستندسازی برای توسعه‌دهندگان نرم‌افزار: مقدمه‌ای بر نوشتن آسان و موثر
مستندسازی، کلید درک پروژه‌های شگفت‌انگیزی است که می‌سازید
مستندسازی برای بسیاری از توسعه‌دهندگان و افراد فنی، کار دشواری به نظر می‌رسد. کتاب «نوشتن فنی برای توسعه‌دهندگان نرم‌افزار» تمام نکات مهمی را که برای آسان‌تر کردن مستندسازی عالی و مطابق با گردش کار و ابزارهای توسعه‌دهندگان نیاز دارید، پوشش می‌دهد.
خوش آمدید، سخن‌وران ماهر!
قبل از شروع، می‌خواهم مانند همیشه با کمی تاریخ شروع کنم.
پدربزرگم برای شرکتی کار می‌کرد که کابل‌های زیردریایی را اختراع و راه‌اندازی می‌کرد، شبکه‌ی بزرگ و طویلی از کابل‌هایی که در زیر دریا پنهان شده‌اند و ارتباطات بین کشورها در سراسر جهان را برقرار می‌کنند. زمانی که او این کابل‌ها را از پشت کشتی‌های بزرگی که بین بریتانیا و کانادا تردد می‌کردند، پهن می‌کرد، در واقع حجم عظیمی از سیم‌های مسی را برای ترافیک تلفن و تلگراف جاسازی می‌کرد.
تا زمانی که او بازنشسته شد، اینترنت به شکل ابتدایی وجود داشت، تلفن‌ها به‌طور گسترده‌ای مورد استفاده قرار می‌گرفتند و او نصیحتی به من کرد که هنوز هم به یاد دارم، با اینکه در آن زمان خیلی کوچک بودم که واقعاً منظور او را درک کنم:
«فیبرهای نوری آینده هستند.»
و او درست می‌گفت. اکنون کابل‌های زیردریایی بیشتری نسبت به هر زمان دیگری وجود دارند که روزانه پتابایت داده را جابه‌جا می‌کنند. کار و سرگرمی ما تا حد زیادی به مقدار نسبتاً کمی از سیم‌های آسیب‌پذیر که روی بستر اقیانوس قرار دارند، مستعد آسیب و حمله هستند و کشورهای کوچک‌تر را از دنیای ارتباطات جدا کرده‌اند، وابسته است.
حالا چرا دارم در کتابی در مورد نوشتن فنی این موضوع را برای شما تعریف می‌کنم؟
پدربزرگم حرفه‌ی خود را به عنوان یک هنرمند فنی آغاز کرد. او طرح‌ها و دستورالعمل‌هایی را برای ساخت و راه‌اندازی این کابل‌های ضروری، به علاوه‌ی نحوه‌ی استفاده از ماشین‌آلات مورد نیاز برای این کار، ترسیم کرد. نمی‌توانم تصور کنم که او هرگز بخش زیادی از کاری را که ما و شما اکنون انجام می‌دهیم، پیش‌بینی می‌کرد (او در سال ۲۰۰۱ درگذشت)، اما می‌توانم تصور کنم که از اینکه در مشاغل مرتبط با او کار می‌کنیم و از برخی از پروژه‌هایی که روی آن‌ها کار کرده‌ام، شگفت‌زده می‌شد.
مقصود من این است که اگر «نوشتن فنی» را به معنای توضیح چیزی به شخص دیگری برای درک آن و نحوه‌ی استفاده از آن برای رسیدن به اهدافش در نظر بگیریم، پس «نوشتن فنی» همه‌جا وجود دارد.
نوشتن فنی چیست؟
دستورالعمل‌های ایمنی، کتابچه‌های راهنمای لوازم خانگی و مبلمان، آموزش‌ها و راهنماهای آنلاین، کتاب‌ها، وبلاگ‌های فنی، دستورالعمل‌های نصب تجهیزات پرخطر و حتی دستورالعمل‌های بازی‌های رومیزی، همگی اشکالی از نوشتن فنی هستند.
کتاب Technical Writing for Software Developers برای توسعه‌دهندگان نرم‌افزاری است که می‌خواهند یاد بگیرند تا در مورد ساخته‌های خود بهتر توضیح دهند. هدف کتاب Technical Writing for Software Developers پوشش دادن تمام مثال‌های بالا نیست. با این حال، همانطور که در مورد بسیاری از موضوعات پیچیده وجود دارد، گاهی اوقات درک اینکه چگونه به این نقطه رسیده‌ایم و مجموعه‌ی کارهای مرتبطی که دیگران انجام می‌دهند، مهم است.
پدربزرگم در دوره‌ای که مدارک تحصیلی ضروری‌تر بود، اما برای کسی که از خانواده‌ی فقیری مانند او می‌آمد، به دست آوردن آن‌ها سخت‌تر بود، بیشتر یک مهندس در قلب خود بود. اما او علاقه‌ی زیادی به کمک به اطرافیانش برای درک موضوعات فنی پیچیده داشت. یکی از افتخارآمیزترین لحظات او در عکسی قدیمی سیاه و سفید ثبت شده است که در آن نحوه کار کابل‌ها را برای شاهزاده فیلیپ جوان (شوهر ملکه‌ی سابق انگلیس) توضیح می‌دهد. من علوم کامپیوتر خواندم و چندین سال را در تیم‌های توسعه نرم‌افزار گذراندم تا اینکه متوجه شدم از توضیح دادن موضوعات فنی بیشتر لذت می‌برم. به طور خلاصه، شما در میان افراد هم‌فکری قرار دارید!
خب، توضیح دادم که نوشتن فنی چیست، اما این همیشه کمکی نمی‌کند. گاهی اوقات، برای کشف کردن آنچه در یک نقش یا وظیفه انتظار می‌رود یا معمول است، راحت‌تر است به چیزهایی نگاه کنید که شامل آن نمی‌شود.
نوشتن فنی چه چیزهایی را شامل نمی‌شود؟
باید بگویم که بسیاری از این وظایف بالقوه به اندازه‌ی تیم بستگی دارد. شما به عنوان تنها فردی در یک تیم یا پروژه که توانایی یا تمایل به برقراری ارتباط و توضیح دارد، ممکن است خود را ملزم به انجام کارهایی ببینید که هرگز پیش‌بینی نمی‌کردید. شاید مشکلی با انجام همه‌ی آن‌ها نداشته باشید، و این اشکالی ندارد. اما شاید هم مشکلی داشته باشید یا زمان و تمایلی برای انجام آن‌ها نداشته باشید، و این هم اشکالی ندارد. آنچه در این بخش ارائه می‌کنم، تلاش برای رسیدن به هسته‌ی کار نوشتن فنی است، بنابراین نباید احساس کنید که مجبور به انجام هیچ‌یک از کارهای دیگر هستید.
نوشتن فنی، کپی‌رایتینگ نیست
بسیاری از افرادی که با آن‌ها صحبت می‌کنید با شنیدن کلمه «نوشتن» فکر می‌کنند که می‌خواهید متن وب‌سایت آن‌ها یا سایر اصلاحات متنی را ویرایش کنید. بسته به موضوع و اندازه‌ی پروژه، ممکن است همچنان به این کار علاقه‌مند باشید و بهترین فرد برای انجام آن باشید، اما نوشتن فنی معمولاً تخصصی است و نیاز به دانش فنی ویژه‌ای دارد. به طور خلاصه، شما احتمالاً مناسب‌ترین فرد نیستید و برای این کار خیلی گران‌قیمت هستید.
نوشتن فنی، نوشتن متن رابط کاربری نیست
در برخی تیم‌ها کار کرده‌ام که نویسندگان فنی متن‌هایی را که روی دکمه‌ها و در دستورات رابط خط فرمان (CLI) ظاهر می‌شوند، مدیریت می‌کنند و برای محصولی که هدف آن توسعه‌دهندگان است، این کار می‌تواند منطقی باشد. با این حال، احتمالاً افراد مناسب‌تری برای این کار وجود دارند که می‌توانید به آن‌ها مشاوره بدهید.
نوشتن فنی، وبلاگ‌نویسی نیست
در اینجا باید مراقب باشم. من زیاد وبلاگ‌نویسی می‌کنم چون از آن لذت می‌برم، و همچنین تقاضای زیادی از بخش‌های بازاریابی در شرکت‌های فنی برای افرادی که فناوری را درک می‌کنند وجود دارد تا به آن‌ها در انتشار این اطلاعات برای سایر افراد فنی کمک کنند. تیم‌های بازاریابی بسیار خوشحال خواهند شد اگر بخواهید وبلاگ‌نویسی کنید، اما این کار برای همه مناسب نیست و مجبور نیستید احساس اجبار کنید.
نوشتن فنی، روزنامه‌نگاری فنی نیست
این مورد دیگری است که در آن من کمکی نمی‌کنم، زیرا من همچنین پادکست خودم را اجرا می‌کنم، در مورد رویدادها گزارش می‌دهم و با افراد صنعت فناوری مصاحبه می‌کنم. داشتن پیشینه‌ی فنی در برخی موضوعات به من بسیار کمک کرده است و یادگیری نوشتن واضح‌تر نیز به من کمک کرده است تا محتوای واضح‌تری تولید کنم.
با این حال، بسیاری از روزنامه‌نگاران فنی که با آن‌ها برخورد می‌کنم، چندان فنی نیستند، و من بارها با سطح سوءتفاهم در برخی گزارش‌های فنی مشکل داشته‌ام و احساس می‌کنم که بخش زیادی از آنچه را که «روزنامه‌نگاری فنی» می‌نامیم، باید بیشتر «روزنامه‌نگاری مصرف‌کننده» در نظر گرفته شود. شاید بسیاری از شما که کتاب Technical Writing for Software Developers را می‌خوانید، مجبور به انجام هرگونه روزنامه‌نگاری فنی نشوید، اما جای تعجب دارد که این همان چیزی است که بسیاری از مردم با شنیدن «نوشتن فنی» به آن فکر می‌کنند.
نوشتن فنی، متن بازاریابی نیست
نویسندگان فنی اغلب در ساختار سازمانی جابجا می‌شوند و گاهی اوقات بخشی از تیم‌های بازاریابی می‌شوند. با این حال، نوشتن فنی فقط باید شامل حقایق باشد (در مورد این موضوع در فصل ۴، ساختار صفحه و چگونگی کمک آن به خواندن بیشتر توضیح داده خواهد شد)، و شما هرگز نباید برای نوشتن بیانیه‌های مطبوعاتی یا هر نوع متن بازاریابی صرف، احساس اجبار کنید.
تعریفی از نوشتن فنی
نوشتن فنی هر نوع رسانه‌ای است، عمدتا کلمات، اما نه همیشه، که به شخص دیگری توضیح می‌دهد که چیزی چگونه کار می‌کند و چگونه می‌تواند از آن استفاده کند. این می‌تواند به اندازه‌ی یک فایل README، نظرات کد و یا صفحات و صفحات آموزش و منابع مرجع باشد. من وظایفی را که خارج از این تعریف در نظر می‌گیرم، شرح دادم، اما برخی از آن‌ها بیشتر از سایرین خارج از آن هستند، و اگر یک نکته‌ی کلیدی از این بخش وجود داشته باشد، این است:
وظیفه‌ی شما این است که بهترین راه را برای توضیح موضوعات پیچیده پیدا کنید. شما از طریق کتاب Technical Writing for Software Developers و در طول زمان به تنهایی، بهترین راه‌هایی را که برای شما و مخاطبتان مفید است، یاد خواهید گرفت.
من چه کسی هستم؟
بخش آخر کمی در مورد من به شما گفت، اما اسم من کریس وارد است. بیشتر با نام مستعار آنلاین «کریس چinchilla» شناخته می‌شوم، زیرا نام واقعی من در انگلیسی آنقدر رایج است که هیچکس نمی‌تواند مرا پیدا کند. در زمان نوشتن کتاب Technical Writing for Software Developers، در برلین زندگی می‌کنم.
با این حال، در لندن به دنیا آمدم و مدت زیادی را در ملبورن گذراندم. من مدرک علوم کامپیوتر چند رسانه‌ای دارم. بعد از اتمام تحصیلاتم، چند سال در گروه‌های موسیقی نواختم و سپس وارد شغل کلاسیک برنامه‌نویسی اوایل ۲۰۰۰ شدم و وب‌سایت‌هایی برای کسب‌وکارهای اولیه تجارت الکترونیک ساختم. بسیاری از این سایت‌ها را با Drupal ساختم، که مرا با نرم‌افزار متن‌باز آشنا کرد.
Drupal در بسیاری از جنبه‌ها به‌ویژه در مورد جامعه‌ی کاربری، از زمان خودش جلوتر بود. من از برنامه‌نویسی لذت می‌برم، اما در اوایل کارم متوجه شدم که ذهنیت لازم برای یک برنامه‌نویس عالی را ندارم. در رویدادهای جامعه‌ی کاربری Drupal، اغلب فعالیت‌هایی برای افرادی که کد نمی‌زنند وجود داشت و من با خلاصه کردن بحث‌های مربوط به مشکلات و نوشتن مستندات شروع به مشارکت کردم.
من در این کار بسیار بهتر بودم و هرگز فکر نمی‌کردم که شغلی باشد که مردم شما را برای انجام آن حقوق بدهند! طی سال‌های بعد از آن، چندین بار به اکوسیستم‌های فناوری و نقش‌های مختلف در نوشتن و ویرایش فنی، وبلاگ‌نویسی فنی، ارتباط با توسعه‌دهندگان و موارد دیگر وارد و خارج شدم. همچنین، معمولاً چند پروژه‌ی جانبی نیز در کنار آن دارم.
چه کسی می‌تواند از کتاب Technical Writing for Software Developers بیاموزد؟
افرادی که در توضیح موضوعات مهارت دارند، اغلب بین رشته‌ها و نقش‌های مختلف قرار می‌گیرند و تجربه دارند. یک نویسنده‌ی فنی خوب اغلب با مهندسی، پشتیبانی، طراحی، محصول و بازاریابی آشنایی دارد و می‌تواند به ایجاد بینش بین این تیم‌ها کمک کند. به طور خلاصه، مهم نیست که تجربه شما یا مسیر رسیدن به آن تجربه چگونه باشد، اگر مشتاق هستید به افراد برای درک [موضوعات] کمک کنید، پس جایگاه شما نویسندگی فنی است!
کتاب Technical Writing for Software Developers بیشتر برای توسعه‌دهندگانی است که می‌خواهند نحوه‌ی توضیح بهتر ساخته‌های خود به دنیا را یاد بگیرند. با این حال، هر کسی که درگیر یک محصول فنی است، می‌تواند چیز مفیدی در اینجا پیدا کند و برای هر یک از خوانندگانی که هم‌اکنون در حال نوشتن مستندات هستید، خوش آمدید!
فکر می‌کنم شما نیز اطلاعات جدید به اندازه‌ی کافی برای ارزشمند کردن خواندن کتاب Technical Writing for Software Developers، به ویژه از فصل ۷، «مدیریت سایر انواع محتوا برای مستندات جامع» به بعد، پیدا خواهید کرد.
تذکری در مورد اصطلاحات
مشابه اصطلاحاتی مانند توسعه‌دهندگان، مهندسان و برنامه‌نویسان، متخصصان در این زمینه نیز خود را به روش‌هایی توصیف می‌کنند که بیشتر یکسان هستند اما برای کسانی که از آن‌ها استفاده می‌کنند، معانی متفاوتی دارند.
دو اصطلاح اصلی که احتمالاً شنیده‌اید به طور متقابل به کار می‌روند، «نویسنده‌ی فنی» و «مستندات» هستند، به علاوه شاید برخی اصطلاحات دیگر هم به آن‌ها اضافه شوند. این اصطلاحات کم و بیش به یک معنا هستند، حداقل بیشتر از عناوین نقش‌های مرتبط با برنامه‌نویسی، اما بسیاری از ما همچنان با آن‌ها مشکل داریم و اصطلاحات دیگر و فراگیرتری را ترجیح می‌دهیم.
برای مثال، همانطور که در فصل ۸ کتاب Technical Writing for Software Developers، «گردش کارهای مشارکتی با فرآیندهای مستندسازی خودکار» پوشش خواهم داد، توضیح فنی امروزه فراتر از کلمات است و عناوین معمولی ما بازتاب دیدگاهی نسبتاً منسوخ است. همچنین معتقدم که یک پورتال مستندات همیشه بهترین مکان برای توضیح همه چیز نباشد.
من با «ارتباط‌گر فنی» (که هنوز در زمان نگارش کتاب Technical Writing for Software Developers در پروفایل لینکدین من وجود دارد) آزمایش کردم. همچنین «مهندس مستندات» را شنیده‌ام، که آن را دوست دارم زیرا نشان می‌دهد که بسیاری از ما در شرکت‌های کوچک‌تر ابزارهای زیادی را برای مستندسازی نیز می‌سازیم. با این حال، چیزی که بسیاری از جوامع نویسندگی فنی برای فراگیر بودن بر آن توافق کرده‌اند، «مستندساز» است. این واژه کامل نیست، اما نشان می‌دهد که همه کسانی که به مستندات خوب کمک می‌کنند یا به آن اهمیت می‌دهند، نقش تمام‌وقت اختصاصی به آن ندارند. همانطور که بسیاری از خوانندگان این کتاب، فرض می‌کنم.
بنابراین، این اصطلاحی است که در سراسر کتاب Technical Writing for Software Developers برای اشاره به شما و ما استفاده خواهم کرد. در مورد کارمان، از مناسب‌ترین اصطلاح برای مطابقت با مورد استفاده و خروجی استفاده خواهم کرد. برای مثال، مستندات، پست‌های وبلاگ، ویدیوها و غیره.
همچنین از اصطلاحات «پروژه» و «محصول» تا حدودی به طور متقابل برای اشاره به آنچه مستند می‌کنید، استفاده خواهم کرد. در ذهن من، «محصول» چیزی تجاری است، در حالی که «پروژه» ممکن است چنین نباشد. با این حال، صرف نظر از چند هشدار و تفاوت‌های کوچک که در صورت لزوم به آن‌ها اشاره خواهم کرد، آن‌ها اساساً یکسان هستند.
وضعیت صنعت
در زمان نگارش کتاب Technical Writing for Software Developers، صنعت فناوری به طور کلی خود را در جایگاه جالبی می‌بیند. سال‌های ولخرجی و ارزش‌گذاری استارت‌آپ‌های فناوری پشت سر ماست. رشد توقف‌ناپذیر فناوری کند شده است و صنعت دیگر نمی‌تواند هر کاری را که می‌خواهد انجام دهد و انتظار داشته باشد که کسی آن را زیر سوال نبرد یا همه آن را بپذیرند.
مهم نیست در بقیه‌ی صنعت فناوری اطراف ما چه اتفاقی بیفتد، یک آمار به طور چشمگیری در نظرسنجی‌های متعدد از عقاید و اکوسیستم‌های توسعه‌دهندگان باقی می‌ماند. مردم خواهان مستندات بهتر هستند و به آن نیاز دارند.
رقابت برای ساخت‌وساز در چند سال گذشته منجر به انبوهی از برنامه‌های کاربردی شد که ممکن است به خوبی ساخته شده باشند یا نباشند، اما اغلب برای کاربران داخلی یا خارجی چندان منطقی به نظر نمی‌رسند. در حال حاضر شاهد کاهش بودجه در این صنعت هستیم و گاهی اوقات، نقش‌هایی خارج از مهندسی برخی از اولین نقش‌هایی هستند که حذف می‌شوند. اما اگر برای یادگیری و یادگیری نحوه‌ی یادگیری پذیرا باشید، برای مدتی نقشی برای شما وجود خواهد داشت.
این از طرف من ساده‌لوحی و دور از صداقت است که به شما بگویم صنعت در میانه‌ی یک تغییر عظیم نیست. فصول آخر کتاب Technical Writing for Software Developers ابزارهای مبتنی بر هوش مصنوعی را پوشش می‌دهد که در یک سال گذشته یا بیشتر همه‌چیز را درنوردیده‌اند. اینکه آیا آن‌ها تغییر دهنده‌ی بازی‌ای هستند که همه قول می‌دهند یا فقط یک سواری دیگر در ترن هوایی تبلیغات، هنوز مشخص نیست، اما شکی نیست که آن‌ها در میان‌مدت بر نحوه‌ی ایجاد و مصرف مستندات ما تأثیر خواهند گذاشت.
ابزارهای خودکاری برای تولید برخی از قسمت‌های مستندات برای مدتی وجود داشته است، اما موج جدید گزینه‌های مبتنی بر هوش مصنوعی قطعاً قدرتمندتر و ظریف‌تر از هر چیزی در گذشته است.
آن‌ها هنوز نمی‌توانند کل الزامات مستندات را پوشش دهند، اما می‌توانند بسیاری از شکاف‌ها و نیازها را پر کنند. با توجه به وضعیت صنعت و نقش ما در آن، حتی اگر همه تصمیم بگیرند پلتفرم‌های مستندات خود را با ربات‌های مبتنی بر هوش مصنوعی جایگزین کنند، آن‌ها همچنان برای مدتی به کسی نیاز دارند تا مواد اولیه‌ای را که هوش مصنوعی را تغذیه می‌کند، بنویسد. شاید ما برای مصرف مستقیم انسان کمتر بنویسیم، اما همچنان خواهیم نوشت.
کتاب Technical Writing for Software Developers برای چه کسانی است؟
کتاب Technical Writing for Software Developers برای کسانی است که عمدتاً کد می‌نویسند، چه توسعه‌دهنده باشند، چه مهندس پشتیبانی یا فروش، یا نویسندگان فنی موجود با ذهنیت فنی. این کتاب پر از توصیه‌ها، نکات و ابزارهایی است که مستندات را با حداقل کار به بهترین شکل ممکن می‌سازد.
اگر کتاب Technical Writing for Software Developers را می‌خوانید، شما کسی هستید که به توضیح موضوعات پیچیده به مؤثرترین روش‌ها اهمیت می‌دهید. شما ممکن است قبلاً یک مستندساز باتجربه باشید که به دنبال ایده‌های جدید و افزایش دانش هستید. یا شاید کم‌تجربه‌تر باشید، اما می‌خواهید کاری برای بهبود وضعیت فعلی پروژه‌ای که در آن مشارکت می‌کنید، انجام دهید. هر چه انگیزه‌ی شما باشد، در این کتاب چیزی برای شما وجود خواهد داشت.
قصد دارم شما را به سفری ببرم که از آموزش اصول اولیه‌ای که باید بدانید تا کشف ایده‌ها و شیوه‌های پیشرفته برای ارتقاء دادن خروجی‌تان نسبت به سایر پروژه‌ها و محصولات، را شامل می‌شود.
کتاب Technical Writing for Software Developers چه چیزهایی را پوشش می‌دهد؟
فصل ۱ کتاب Technical Writing for Software Developers، چرا، چه کسی و چگونه‌ی نوشتن فنی، در مورد تمام ذی‌نفعان مختلف با علاقه به مستندات خوب و آنچه که می‌تواند برای آن‌ها به ارمغان بیاورد، صحبت می‌کند.
فصل ۲ کتاب Technical Writing for Software Developers، درک انواع مختلف مستندات در توسعه نرم‌افزار، انواع مختلف مستنداتی را که می‌توانند یک مستندات را تشکیل دهند، بررسی می‌کند.
فصل ۳ کتاب Technical Writing for Software Developers، زبان و اصول بنیادی توضیح، اصول گرامر را پوشش می‌دهد که مستندات را واضح‌تر و با اعتماد به نفس‌تر می‌کند.
فصل ۴ کتاب Technical Writing for Software Developers، ساختار صفحه و چگونگی کمک آن به خواندن، توضیح می‌دهد که چگونه ساختار صفحه محتوا را برای خوانندگان آسان‌تر می‌کند.
فصل ۵ کتاب Technical Writing for Software Developers، فرایند نوشتن فنی، در مورد فرایند ایده‌آل برای دنبال کردن نوشتن فنی مشارکتی توصیه‌هایی ارائه می‌کند.
فصل ۶ کتاب Technical Writing for Software Developers، انتخاب ابزار مناسب برای ایجاد کارآمد مستندات، در مورد گزینه‌ها و نحوه‌ی انتخاب ابزارهایی که به ایجاد، همکاری و ارائه‌ی مستندات به خوانندگان کمک می‌کنند، بحث می‌کند.
فصل ۷ کتاب Technical Writing for Software Developers، مدیریت سایر انواع محتوا برای مستندات جامع، انواع دیگر رسانه‌هایی را که می‌توانید به مستندات اضافه کنید و باعث تکمیل کلمات شما می‌شوند، بررسی می‌کند.
فصل ۸ کتاب Technical Writing for Software Developers، گردش کارهای مشارکتی با فرآیندهای مستندسازی خودکار، به چگونگی خودکار کردن بسیاری از فرآیندهای رایج در ایجاد مستندات می‌پردازد.
فصل ۹ کتاب Technical Writing for Software Developers، فرصت‌های بهبود مستندات با ابزارهای هوش مصنوعی، در مورد اینکه چگونه موج جدید ابزارهای هوش مصنوعی می‌توانند در ایجاد مستندات به شما کمک کنند و آن‌ها را ارتقا دهند، صحبت می‌کند.
سرفصل‌های کتاب Technical Writing for Software Developers:
- Technical Writing for Software Developers
- Contributors
- About the author
- About the reviewers
- Preface
- Chapter 1: The Why, Who, and How of Tech Writing
- Chapter 2: Understanding Different Types of Documentation in Software Development
- Chapter 3: Language and the Fundamental Mechanics of Explaining
- Chapter 4: Page Structure and How It Aids Reading
- Chapter 5: The Technical Writing Process
- Chapter 6: Selecting the Right Tools for Efficient Documentation Creation
- Chapter 7: Handling Other Content Types for Comprehensive Documentation
- Chapter 8: Collaborative Workflows with Automated Documentation Processes
- Chapter 9: Opportunities to Enhance Documentation with Al Tools
- Index
- Other Books You May Enjoy
جهت دانلود کتاب Technical Writing for Software Developers می‌توانید پس از پرداخت، دریافت کنید.
دیدگاهها
هیچ دیدگاهی برای این محصول نوشته نشده است.