درک ساختار سند در نگارش فنی

یکی از جنبه های اساسی که اساس نگارش فنی را تشکیل می دهد، ساختار سند است. برای ایجاد اسناد فنی موثر، باید اجزای کلیدی ساختار سند را درک کنید.

این مولفه ها در کنار هم کار می کنند تا یک تجربه خواندن منسجم و آموزنده را ارائه دهند.

اجزای ساختار سند در نگارش فنی

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

صفحه عنوان

صفحه عنوان اولین چیزی است که خوانندگان با آن مواجه می شوند و لحن سند را تنظیم می کند.

این معمولاً شامل عنوان سند، نام نویسنده، تاریخ انتشار و وابستگی‌ها یا مؤسسات مربوطه است.

چکیده یا خلاصه اجرایی

یک خلاصه انتزاعی یا اجرایی به طور خلاصه نکات، یافته ها یا توصیه های اصلی سند را مرور می کند. این به عنوان یک تیزر عمل می کند، به خوانندگان نگاهی اجمالی به آنچه انتظار دارند می دهد و به آنها کمک می کند تصمیم بگیرند که آیا کل سند را بخوانند یا خیر.

یک چکیده مؤثر در نگارش فنی، جایی که زمان اغلب محدود است، ارزشمند است.

فهرست مطالب

فهرست مطالب ساختار سند را مشخص می‌کند و به خوانندگان کمک می‌کند بخش‌های خاص را به سرعت پیدا کنند. عناوین فصل یا بخش را به همراه شماره صفحات مربوطه فهرست می کند.

یک فهرست مطالب به خوبی سازماندهی شده برای اسناد دارای بخش ها یا فصل های متعدد ضروری است.

فهرست شکل ها و جداول

اگر سند شامل شکل ها، جداول یا تصاویر باشد، پس از فهرست مطالب باید فهرستی از شکل ها و جداول ارائه شود.

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

مقدمه

مقدمه با ارائه زمینه، اطلاعات زمینه و هدف آن، زمینه را برای سند فراهم می کند. همچنین دامنه و اهداف را مشخص می کند و به خوانندگان درک روشنی از آنچه باید انتظار داشته باشد، می دهد.

یک مقدمه خوش ساخت توجه خوانندگان را به خود جلب می کند و آنها را برای ادامه خواندن ترغیب می کند.

بدن

متن سند حاوی محتوای اصلی است. این به بخش ها یا فصل هایی تقسیم می شود که هر یک به موضوع یا موضوع فرعی خاصی می پردازد. این بخش ها باید به طور منطقی سازماندهی شوند و از یک ساختار واضح پیروی کنند که به آرامی از یک نقطه به نقطه دیگر جریان دارد.

سرفصل‌ها و زیرعنوان‌ها در هدایت خوانندگان از طریق متن سند بسیار مهم هستند.

سرفصل ها و زیرعنوان ها

سرفصل ها و زیرعنوان ها محتوا را به قطعات قابل مدیریت تقسیم می کنند و یک ساختار سلسله مراتبی ارائه می دهند. آنها به خوانندگان کمک می کنند تا در سند پیمایش کنند، اطلاعات مرتبط را بیابند و سازماندهی ایده ها را درک کنند.

قالب بندی منسجم و سلسله مراتب منطقی سرفصل ها برای وضوح ضروری است.

مراجع و استنادها

نوشتن فنی اغلب شامل ارجاع به منابع خارجی، تحقیقات یا کارهای قبلی است.

ارجاعات و استنادها با فرمت مناسب برای اعتبار بخشیدن به منابع، ایجاد اعتبار، و اجازه دادن به خوانندگان برای کشف مطالب مرتبط برای اطلاعات بیشتر ضروری هستند.

اکنون که اجزای اصلی یک سند فنی را می دانید، بیایید نحوه استفاده صحیح از سرفصل ها در محتوای فنی خود را بررسی کنیم.

ایجاد سرفصل ها و زیرعنوان های موثر در نگارش فنی

هنگام تهیه محتوای فنی ارزشمند، اطلاعات پیچیده باید به گونه ای ارائه شود که هضم و درک آن برای خواننده آسان باشد. سرفصل ها و زیرعنوان ها ابزار ضروری برای دستیابی به این امر هستند.

سرفصل ها و زیرعنوان های خوش ساخت ساختاری را برای سند شما فراهم می کنند و به عنوان تابلوهای راهنما عمل می کنند و خوانندگان شما را از طریق محتوا راهنمایی می کنند.

مزایای سرفصل ها و زیرعنوان های موثر در نگارش فنی

افزایش خوانایی

اسناد فنی اغلب حاوی اطلاعاتی از جمله حقایق، ارقام و اصطلاحات فنی هستند. بدون سرفصل‌ها و زیرعنوان‌های واضح، خوانندگان ممکن است احساس ناراحتی کنند و برای یافتن اطلاعات لازم تلاش کنند.

سرفصل‌های مؤثر محتوا را به بخش‌های قابل مدیریت تقسیم می‌کنند و خوانندگان را برای پیمایش و درک آن آسان‌تر می‌کنند.

سازماندهی اطلاعات

سرفصل ها و زیرعنوان ها به عنوان یک نقشه راه برای سند شما عمل می کنند. آنها به شما کمک می کنند افکار خود را سازماندهی کنید و اطلاعات را به ترتیب منطقی ارائه دهید.

این سازمان به ویژه در نگارش فنی بسیار مهم است، جایی که مفاهیم اغلب به هم مرتبط هستند و بر روی یکدیگر ساخته می شوند.

کمک به Skimming و Scanning

همه خوانندگان سند فنی شما را از ابتدا تا انتها نمی خوانند. بسیاری از آنها محتوا را اسکن می کنند و به دنبال اطلاعات خاصی می گردند.

سرفصل‌ها و زیرعنوان‌های دارای ساختار مناسب به این خوانندگان اجازه می‌دهند تا مرتبط‌ترین بخش‌ها را به سرعت پیدا کنند.

برجسته کردن نکات کلیدی

سرفصل‌ها و زیرعنوان‌ها همچنین می‌توانند نکات کلیدی یا نکات مهم را به صورت استراتژیک برجسته کنند.

این به تأکید بر اطلاعات مهم و اطمینان از برجسته شدن آن در ذهن خواننده کمک می کند.

اکنون که فهمیدید چرا باید از عناوین مناسب در محتوای فنی خود استفاده کنید، در بخش بعدی نحوه انجام صحیح این کار را بررسی می کنیم.

دستورالعمل هایی برای ایجاد سرفصل های موثر در نگارش فنی

توصیفی و مشخص باشد

سرفصل‌های شما باید نشان‌دهنده واضحی از آنچه در بخش است ارائه دهند.

عناوین مبهم یا کلی مانند “مقدمه” یا “نتیجه گیری” مفید نیستند.

در عوض، عناوین توصیفی و خاص را انتخاب کنید که ماهیت محتوا را بیان می کند.

مثال:

• مبهم: “تحلیل داده ها”
• اختصاصی: “تحلیل آماری بازخورد مشتریان”

از ساختار موازی استفاده کنید

با استفاده از ساختار موازی در سرفصل‌های خود یکپارچگی را حفظ کنید.

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

به طور معمول، این شامل استفاده از اسم یا عبارات اسمی است.

مثال:

• موازی نیست: “طراحی نرم افزار” و “برای کدنویسی کارآمد”
• موازی: “طراحی نرم افزار” و “کدنویسی کارآمد”

آنها را مختصر نگه دارید

در حالی که توصیفی بودن ضروری است، از طولانی کردن سرفصل های خود اجتناب کنید.

در حالت ایده آل، سرفصل ها باید مختصر و دقیق باشند.

عناوین طولانی می توانند خوانندگان را گیج کنند و هدف ارائه ناوبری سریع را شکست دهند.

مثال:

• بیش از حد طولانی: “فرایند گام به گام دقیق برای پیکربندی پروتکل های امنیتی شبکه در یک محیط شرکت”
• مختصر: “پیکربندی پروتکل های امنیتی شبکه”

از حروف بزرگ استفاده کنید

برای سرفصل‌های خود از یک سبک حروف بزرگ پیروی کنید.

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

مثال:

• مورد جمله: «انجام امکان سنجی منابع انرژی تجدیدپذیر».
• مورد عنوان: “انجام امکان سنجی منابع انرژی های تجدیدپذیر”

از علامت گذاری پرهیز کنید

به طور کلی، بهتر است از استفاده از علائم نگارشی مانند دو نقطه یا نقطه ویرگول در سرفصل ها خودداری کنید.

هدف این است که سرفصل ها ساده و خوانا باشند. در صورت لزوم، عنوان را مجدداً بیان کنید تا نیازی به علامت گذاری نباشد.

مثال:

• اشتباه: “عناصر کلیدی مدیریت پروژه”.
• سمت راست: “عناصر کلیدی مدیریت پروژه”

از سلسله مراتب به طور موثر استفاده کنید

در اسناد فنی، شما اغلب برای نشان دادن سلسله مراتب اطلاعات به سطوح مختلف سرفصل نیاز دارید. اطمینان حاصل کنید که سلسله مراتب واضح و سازگار است.

به طور معمول، این شامل اندازه های مختلف فونت، سبک ها یا سیستم های شماره گذاری برای سطوح مختلف است.

مثالی از استفاده از اعداد برای سلسله مراتب:

1. مقدمه

1.1 پس زمینه

1.2 اهداف

1. بررسی ادبیات

2.1 تحقیقات قبلی

2.2 روندهای فعلی

در مرحله بعد، بیایید نحوه استفاده از زیرعنوان را بررسی کنیم.

رهنمودهایی برای ساخت عناوین فرعی در نگارش فنی

ثبات را حفظ کنید

وقتی صحبت از سرفصل‌ها می‌شود، سازگاری کلیدی است. اطمینان حاصل کنید که عناوین فرعی در همان سطح دارای ساختار و قالب بندی ثابتی هستند.

این سازگاری به خوانایی کمک می کند و خوانندگان را برای پیمایش سند شما آسان تر می کند.

مثال:

• ساختار ثابت: “مزایای انرژی خورشیدی” و “معایب انرژی خورشیدی”
• ساختار ناسازگار: “مزایای انرژی خورشیدی” و “تحلیل جنبه های منفی”

زمینه را ارائه دهید

عناوین فرعی نباید به صورت مجزا وجود داشته باشند.

هر عنوان فرعی باید با عنوان قبلی مرتبط باشد و زمینه را برای محتوای زیر فراهم کند.

این جریان یکنواخت اطلاعات را تضمین می کند.

مثال:

• عنوان: انرژی خورشیدی به عنوان یک منبع تجدید پذیر

• عنوان فرعی: “مزایای انرژی خورشیدی”

• عنوان فرعی: معایب انرژی خورشیدی

از عنوان های فرعی برای اطلاعات گروه استفاده کنید

از عناوین فرعی می توان برای گروه بندی اطلاعات مرتبط با هم استفاده کرد و درک مفاهیم را برای خوانندگان آسان تر می کند.

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

مثال:

عنوان: “تکنولوژی های توسعه وب”

• عنوان فرعی: “تکنولوژی های پیشرو”

• زیر عنوان: “HTML”

• زیر عنوان: “CSS”

• عنوان فرعی: “تکنولوژی های پشتیبان”

• زیر عنوان: “Node.js”

• عنوان فرعی: یاقوت روی ریل

مختصر و مشخص باشد

عناوین فرعی نیز مانند سرفصل ها باید مختصر و مشخص باشند.

از عناوین فرعی طولانی که می توانند خوانندگان را سردرگم کنند خودداری کنید. در عوض، بر انتقال نکته اصلی بخش تمرکز کنید.

مثال:

• مختصر: “چالش ها در تست نرم افزار”
• خاص: “بررسی چالش های تست سازگاری”

اشتباهاتی که هنگام استفاده از عنوان و عنوان فرعی در نگارش فنی باید اجتناب کرد

بیایید برخی از مواردی را که هنگام استفاده از سرفصل‌ها و زیرعنوان‌ها در نوشتار فنی باید اجتناب کنید، بررسی می‌کنیم.

استفاده بیش از حد از عناوین فرعی

در حالی که عنوان های فرعی برای تجزیه محتوا ضروری هستند، استفاده بیش از حد از آنها می تواند خوانندگان را تحت تأثیر قرار دهد.

از عناوین فرعی با احتیاط استفاده کنید و روی مهم ترین نقاط یا بخش هایی که نیاز به تقسیم بیشتر دارند، تمرکز کنید.

ناسازگار بودن

سازگاری در نوشتن فنی از اهمیت بالایی برخوردار است. ناهماهنگی در قالب بندی، حروف بزرگ یا ساختار می تواند خوانندگان را سردرگم کند.

از الگوها و راهنماهای سبک برای حفظ یکنواختی استفاده کنید.

ایجاد سرفصل بعد از نوشتن

نوشتن سرفصل‌ها و زیرعنوان‌ها نباید یک فکر بعدی باشد.

آنها باید در مرحله برنامه ریزی سند شما در نظر گرفته شوند.

این تضمین می کند که محتوا به طور منطقی جریان داشته باشد و سرفصل ها از همان ابتدا یک نقشه راه هستند.

غفلت از بررسی و بازنگری

هنگامی که سرفصل ها و زیرعنوان های خود را ایجاد کردید، بررسی و بازنگری آنها ضروری است.

اطمینان حاصل کنید که آنها به طور دقیق محتوا را منعکس می کنند و در بهترین نظم برای راهنمایی مؤثر خوانندگان هستند.

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

استفاده از فهرست ها، جداول و وسایل کمک بصری در نگارش فنی

استفاده مؤثر از فهرست ها، جداول و وسایل کمک بصری برای تسهیل درک و افزایش کیفیت کلی محتوای فنی ضروری است.

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

استفاده از لیست های شماره گذاری شده در نگارش فنی

لیست های شماره گذاری شده برای انتقال دنباله ای از مراحل یا ساختار سلسله مراتبی مناسب هستند.

به عنوان مثال، اگر در حال نوشتن یک کتابچه راهنمای کاربر برای مونتاژ مبلمان هستید، می توانید با استفاده از یک لیست شماره گذاری، مراحل فرآیند مونتاژ را مشخص کنید.

دستورالعمل استفاده از لیست های شماره گذاری شده در نگارش فنی

سازگاری

قالب بندی ثابت را در سراسر لیست حفظ کنید.

اطمینان حاصل کنید که هر مورد با یک عدد شروع می شود و با نقطه گذاری، معمولاً یک نقطه، پایان می یابد.

موازی سازی

ساختار موارد موجود در لیست را موازی نگه دارید. این به معنای استفاده از دستور زبان و ساختار جمله برای هر مورد است.

به عنوان مثال، اگر اولین مورد یک عبارت فعل است، همه موارد بعدی نیز باید عبارت های فعل باشند.

وضوح

در توضیحات خود واضح و مختصر باشید.

هر مورد در یک لیست شماره گذاری شده باید مستقل و قابل درک باشد.

کم استفاده کنید

لیست های شماره گذاری شده باید برای موقعیت هایی که ترتیب اقلام ضروری است رزرو شود.

استفاده بیش از حد از آنها می تواند سند شما را به هم ریخته و کمتر خوانا کند.

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

استفاده از لیست های گلوله ای در نگارش فنی

لیست های گلوله ای برای ارائه اطلاعاتی مناسب هستند که به ترتیب خاصی نیاز ندارند، مانند لیستی از ویژگی ها، مزایا یا الزامات.

رهنمودهایی برای استفاده از لیست های گلوله ای در نگارش فنی

سازگاری

مانند لیست های شماره گذاری شده، قالب بندی ثابت را حفظ کنید.

از همان نوع نقطه گلوله (به عنوان مثال، دایره، مربع، یا خط تیره) در سراسر لیست استفاده کنید.

موازی سازی

مانند لیست های شماره گذاری شده، اطمینان حاصل کنید که هر مورد از ساختار دستوری یکسانی پیروی می کند.

اگر یک مورد با فعل شروع شود، همه آنها باید با فعل شروع شوند.

وضوح

هر نقطه را مختصر و متمرکز کنید.

از جملات یا پاراگراف های طولانی در لیست گلوله ای خودداری کنید.

سلسله مراتب

اگر نیاز به نشان دادن سلسله مراتب بین موارد وجود دارد، می توانید از گلوله های فرعی استفاده کنید.

با این حال، برای حفظ وضوح، از لانه سازی بیش از حد خودداری کنید.

استفاده از قدرت جداول در نگارش فنی

جداول در نوشتن فنی برای ارائه داده های ساختاریافته، مقایسه ها و اطلاعات پیچیده ضروری هستند. آنها روشی مختصر و سازمان یافته برای نمایش اطلاعاتی که ممکن است در متن ساده دست و پا گیر باشند ارائه می دهند.

راهنمای استفاده از جداول در نگارش فنی

وضوح

هدف اصلی جدول این است که داده های پیچیده را قابل درک تر کند.

اطمینان حاصل کنید که چیدمان و برچسب‌های جدول برای تفسیر ساده هستند.

سادگی

طراحی میز را تا حد امکان ساده نگه دارید.

از رنگ‌های غیرضروری، سایه‌زنی یا قالب‌بندی پیچیده که حواس خوانندگان را از محتوا منحرف می‌کند، خودداری کنید.

سازگاری

یک ساختار ثابت در سراسر جدول حفظ کنید.

از همان قالب بندی برای سرصفحه ها، ستون ها و ردیف ها استفاده کنید. این سازگاری به خوانایی کمک می کند.

برچسب زدن

برای سطرها و ستون ها عناوین و برچسب های واضح و مختصر ارائه دهید.

این برچسب ها باید محتوای هر بخش را بدون نیاز به توضیح بیشتر توضیح دهند.

افزایش درک با کمک بصری در نوشتن فنی

وسایل کمک بصری مانند نمودارها، نمودارها، نمودارها و تصاویر در نوشتن فنی بسیار حیاتی هستند. آنها مفاهیم پیچیده را ساده می کنند و درک خواننده را افزایش می دهند.

راهنمای استفاده از ابزارهای بصری در نگارش فنی

ارتباط

اطمینان حاصل کنید که وسایل کمک بصری مستقیماً با محتوا ارتباط دارند.

آنها باید یک نکته را روشن یا نشان دهند، نه اینکه صرفاً به عنوان عناصر تزئینی عمل کنند.

دسترسی

اگر سند شما به صورت الکترونیکی توزیع می شود، اطمینان حاصل کنید که وسایل کمک بصری برای همه خوانندگان، از جمله افراد دارای معلولیت، قابل دسترسی است.

توضیحات متن جایگزین برای تصاویر ارائه دهید و از سازگاری با صفحه خوان ها اطمینان حاصل کنید.

سازگاری

یک سبک و قالب ثابت برای وسایل کمک بصری در سراسر سند حفظ کنید.

این ثبات ظاهر حرفه ای کار شما را افزایش می دهد.

مناسب بودن

نوع کمک بصری را انتخاب کنید که به بهترین شکل پیام شما را منتقل می کند.

به عنوان مثال، نمودارهای دایره ای برای نشان دادن نسبت ها عالی هستند، در حالی که نمودارهای خطی برای نشان دادن روندها در طول زمان مناسب هستند.

مشکلات رایجی که هنگام استفاده از فهرست ها، جداول و وسایل کمک بصری در نوشتن فنی باید از آنها اجتناب کرد.

ازدحام بیش از حد

سند خود را با فهرست ها، جداول و وسایل کمک بصری بیش از حد بارگذاری نکنید.

از آنها به صورت استراتژیک برای تکمیل محتوای خود استفاده کنید، نه اینکه آن را تحت الشعاع قرار دهید.

برچسب های ناکافی

همیشه برچسب های واضح و توصیفی برای لیست ها، جداول و وسایل کمک بصری ارائه دهید.

برچسب های نامشخص می تواند خوانندگان را گیج کند.

قالب بندی ناسازگار

یک سبک و قالب بندی ثابت برای این عناصر در سراسر سند خود حفظ کنید.

ناهماهنگی ها می تواند جریان و درک محتوا را مختل کند.

فقدان زمینه

از ارائه لیست ها، جداول یا وسایل کمک بصری بدون زمینه یا توضیح مناسب خودداری کنید.

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

نتیجه گیری

در این قسمت از راهنما، ساختار اکثر اسناد فنی را یاد گرفتید و نکات زیادی در مورد نحوه ساختاربندی صحیح محتوای خود با استفاده از سرفصل ها، زیرعنوان ها، فهرست ها، کمک های بصری و موارد دیگر دریافت کردید.

توجه: حتماً این راهنما را مجدداً مرور کنید تا نحوه کار با ساختار مناسب را به خود یادآوری کنید.

اگر سوال، اصلاح یا پیشنهادی دارید، لطفا در نظرات زیر با من در میان بگذارید. همچنین می توانید در لینکدین با من ارتباط برقرار کنید.

در قسمت بعدی می بینمت!