براہ کرم یہاں کلک کریں تاکہ مدد کریں۔ ڈیوڈ میک موریے ویب ہوسٹنگ کی ادائیگی کریں:
کچھ بھی چھوٹی رقم عطیہ کریں جو آپ دے سکیں!
آن لائن ٹیکنیکل رائٹنگ مفت رہے گی۔

تکنیکی دستاویزات (جن میں ہینڈ بکس، وائیٹ پیپرز اور گائیڈز شامل ہیں) مختلف صنعت، پیشے، یا تنظیم کے لحاظ سے مختلف ڈیزائن رکھتے ہیں۔ یہ باب آپ کو ایک روایتی ڈیزائن دکھاتا ہے۔ اگر آپ تکنیکی تحریر کا کورس کر رہے ہیں تو اس بات کو یقینی بنائیں کہ اس باب میں پیش کردہ ڈیزائن قابل قبول ہے۔ اگر آپ سائنس، کاروبار، یا حکومت کے سیاق و سباق میں تکنیکی دستاویز لکھ رہے ہیں تو یہ بات بھی درست ہے۔

NotebookLM-generated infographic of this chapter اس باب کا نوٹس بک ایل ایم کی جانب سے تیار کردہ انفوقرافک

نوٹ: کئی سالوں سے یہ آن لائن تکنیکی تحریر کا نصاب عمومی طور پر رپورٹس کو کسی بھی چیز کے طور پر بیان کرتا تھا جس میں تکنیکی معلومات موجود ہوں۔ لیکن چونکہ "رپورٹ" تکنیکی دستاویز کی ایک مخصوص قسم کی طرف اشارہ کرتی ہے، اس لیے عمومی "ٹیک ڈاک" میں تبدیلی ضروری تھی، جو تکنیکی دستاویز کا مختصر نام ہے۔

ٹیک ڈاکس (تکنیکی دستاویزات کا عمومی نام) کے لیے مخصوصات ہیں جیسے کسی دوسرے قسم کے منصوبے کے لیے۔ ٹیک ڈاکس کے مخصوصات میں ترتیب، تنظیم اور مواد، سرخیوں اور فہرستوں کی شکل، گرافکس کا ڈیزائن وغیرہ شامل ہیں۔ ٹیک ڈاکس کے لیے درکار ڈھانچہ اور شکل کا فائدہ یہ ہے کہ آپ یا کوئی اور ان کی توقع کر سکتا ہے کہ یہ ایک معروف انداز میں تیار کیے جائیں گے—آپ جانتے ہیں کہ کیا دیکھنا ہے اور کہاں دیکھنا ہے۔ ٹیک ڈاکس عام طور پر جلدی پڑھی جاتی ہیں—لوگ معلومات تک پہنچنے کے لیے جلدی میں ہوتے ہیں، اہم حقائق، نتائج، اور دیگر ضروریات۔ ایک معیاری ٹیک ڈاک فارمیٹ جیسے ایک جانا پہچانا محلہ ہے۔

جب آپ کسی ٹیک ڈاک کے ڈیزائن کا تجزیہ کرتے ہیں تو آپ دیکھتے ہیں کہ کچھ سیکشن کتنے دہرائے گئے ہیں۔ یہ تکرار اس بات سے وابستہ ہے کہ لوگ ٹیک ڈاک کیسے پڑھتے ہیں۔ وہ ٹیک ڈاک کو سیدھا نہیں پڑھتے: وہ ایگزیکٹو سمری سے شروع کر سکتے ہیں، ادھر ادھر چھلانگ لگا سکتے ہیں، اور شاید ہر صفحہ نہیں پڑھیں۔ آپ کا چیلنج یہ ہے کہ آپ ٹیک ڈاک ایسے ڈیزائن کریں کہ یہ قارئین آپ کے اہم حقائق اور نتائج کا سامنا کریں، چاہے انہوں نے ٹیک ڈاک کا کتنا حصہ پڑھا ہو یا وہ کس ترتیب میں پڑھتے ہیں۔

ضرور دیکھیں مثال ٹیک ڈاکس.

اس باب میں ایک عام تکنیکی رپورٹ کے معیاری اجزاء پر بحث کی گئی ہے۔ درج ذیل سیکشنز آپ کو ان اجزاء کے ذریعے رہنمائی فراہم کرتے ہیں، اہم خصوصیات کی نشاندہی کرتے ہیں۔ جب آپ ان ہدایتوں کو پڑھیں اور استعمال کریں، تو یاد رکھیں کہ یہ ہدایتیں ہیں، احکامات نہیں۔ مختلف کمپنیاں، پیشے اور تنظیمیں اپنے اپنے مختلف ہدایت نامے رکھتے ہیں، لہذا آپ کو ان میں سے اپنے عمل کو ان کے مطابق ڈھالنا ہوگا، جیسا کہ یہاں پیش کردہ ہدایتیں ہیں۔

ترسیل کا پیغام

ٹرانسمیٹیل پیغام یا تو ایک کور خط (یا میمو) ہے یا ایک ای میل۔ جسمانی خط (یا میمو) یا تو ٹیک ڈاک کے باہر کاغذی کلپ کے ساتھ منسلک ہے یا ٹیک ڈاک میں شامل ہے۔ ای میل میں ٹیک ڈاک کا لنک ہوتا ہے یا ٹیک ڈاک منسلک ہوتا ہے۔ یہ آپ کی جانب سے—ٹیک ڈاک تخلیق کرنے والے—کی جانب سے وصول کنندہ کے لیے ایک مواصلات ہے، وہ شخص جو ٹیک ڈاک کی درخواست کرتا ہے اور جو آپ کو آپ کی ماہر مشاورت کے لیے پیسے بھی دے سکتا ہے۔ بنیادی طور پر، اس میں کہا گیا ہے "ٹھیک ہے، یہ ہے وہ ٹیک ڈاک جو ہم نے اس تاریخ تک مکمل کرنے پر اتفاق کیا تھا۔ مختصراً، اس میں یہ اور وہ شامل ہیں، لیکن اس میں یہ یا وہ شامل نہیں ہے۔ مجھے بتائیں کہ کیا یہ آپ کی ضروریات کو پورا کرتا ہے۔" ٹرانسمیٹیل پیغام میں اس تناظر کی وضاحت کی گئی ہے—ان واقعات کی جو ٹیک ڈاک کے وجود کا سبب بنے۔ اس میں ٹیک ڈاک کے بارے میں معلومات شامل ہوتی ہیں جو ٹیک ڈاک میں شامل نہیں ہوتی۔

Business letter and email versions of transmital message
منتقلی خط اور منتقلی پیغام کی مثالیں۔

ٹرانسمیٹل خط کے مثال میں، معیاری کاروباری خط کی شکل پر توجہ دیں۔ اگر آپ ایک داخلی ٹیک ڈاک لکھتے ہیں تو اس کے بجائے یادداشت کی شکل استعمال کریں؛ دونوں صورتوں میں، مواد اور تنظیم یکساں ہیں:

پہلا پیراگراف۔ ٹیک ڈوک کا نام اٹالکس میں لکھا گیا ہے۔ یہ اس معاہدے کی تاریخ کا بھی ذکر کرتا ہے جس میں ٹیک ڈوک لکھنے کا فیصلہ کیا گیا تھا۔

درمیانی پیراگراف۔ ٹیک ڈاک کے مقصد پر توجہ مرکوز کرتا ہے اور ٹیک ڈاک کے مواد کا مختصر جائزہ پیش کرتا ہے۔

آخری پیراگراف۔ پڑھنے والے کو حوصلہ افزائی کرتا ہے کہ اگر کوئی سوالات، تبصرے، یا خدشات ہیں تو رابطہ کریں۔ یہ ایک نیک خواہش کے ساتھ ختم ہوتا ہے، امید ظاہر کرتا ہے کہ پڑھنے والا تکنیکی دستاویز کو تسلی بخش پائے۔

جیسا کہ کسی اور عنصر کی طرح، آپ کو اس پیغام (یا یادداشت) کے مواد میں مخصوص حالات کے لیے تبدیلیاں کرنے کی ضرورت ہو سکتی ہے۔ مثال کے طور پر، آپ دوسرا پیراگراف شامل کرنا چاہیں گے، جس میں وہ سوالات درج ہوں جن پر آپ چاہتے ہیں کہ قارئین ٹیک دستاویز کا جائزہ لیتے وقت غور کریں۔

کور، عنوان صفحہ اور لیبل

اگر آپ کا ٹیک ڈاک دس صفحات سے زیادہ ہے تو اسے کسی طریقے سے باندھ دیں اور سرورق کے لیے ایک لیبل بنائیں۔

ڈھانپنے والا

کوریج ٹیک ڈاکس کو ایک مضبوط، پروفیشنل نظر دیتے ہیں اور ساتھ ہی تحفظ بھی فراہم کرتے ہیں۔ آپ بہت ساری اقسام کے کوریج میں سے انتخاب کر سکتے ہیں۔ ان نکات کو ذہن میں رکھیں:

عموماً کم پسندیدہ ہیں ڈھیلے پتے والی نوٹ بکیں، یا رنگ والے بائنڈرز۔ یہ چھوٹے تکنیکی دستاویزات کے لیے بہت بڑے ہوتے ہیں، اور صفحات کے سوراخ پھٹنے کا رجحان رکھتے ہیں۔ البتہ، رنگ بائنڈر صفحات کو تبدیل کرنا آسان بناتا ہے؛ اگر آپ کی تکنیکی دستاویز اس طرح استعمال ہوگی، تو یہ ایک اچھا انتخاب ہے۔ "اعلیٰ معیار" میں بہت زیادہ شاندار جلدیں شامل ہیں جن کا چمڑے جیسا نظر اور سنہری کٹ ہے۔ ان سے پرہیز کریں—اسے سادہ، سادہ اور عملی رکھیں۔

عنوان صفحہ

اپنی سادگی میں، ایک ٹیک ڈاک کا عنوان آگے کی جلد پر موجود چیز کا ایک نقل ہے— ممکنہ طور پر چند تفصیلات کے ساتھ۔

عنوان صفحہ دیکھیں خلاصہ اور انتظامی خلاصہ.

لیبلز

اپنے ٹیک ڈاک کے کور کے لیے ایک لیبل بنانا یقیناً یقینی بنائیں۔ یہ ایک ایسا قدم ہے جو بعض ٹیک ڈاک لکھنے والے بھول جاتے ہیں۔ بغیر لیبل کے، ایک ٹیک ڈاک بے نام رہتا ہے؛ اسے نظر انداز کر دیا جاتا ہے۔

لیبل بنانے کا بہترین طریقہ یہ ہے کہ اپنے ورڈ پروسیسنگ سافٹ ویئر کا استعمال کرتے ہوئے ایک معیاری صفحے پر لیبل کی معلومات کے گرد ایک گرافک باکس ڈیزائن کریں۔ اسے پرنٹ کریں، پھر کسی کاپی کی دکان پر جائیں اور اسے براہ راست ٹیک ڈاک کور پر فوٹو کاپی کروا لیں۔

لیبل پر زیادہ معلومات نہیں ہوتی: ٹیک ڈاک کا عنوان، آپ کا نام، آپ کی تنظیم کا نام، ٹیک ڈاک کا ٹریکنگ نمبر، اور ایک تاریخ۔ لیبل کے لیے کوئی معیاری تقاضے نہیں ہیں، حالانکہ آپ کی کمپنی یا تنظیم کے اپنے معیاری تقاضے ہونے چاہئیں۔ (نیچے ٹیک ڈاک کے لیبل کی ایک مثال دکھائی گئی ہے.)


ترسیلی خط اور تکنیکی دستاویز کا سرورق (سرورق لیبل کے ساتھ)۔

خلاصہ اور ایگزیکٹو سمری

زیادہ تر تکنیکی ٹیک ڈوک میں کم از کم ایک خلاصہ—ہوتا ہے، کبھی کبھی دو، جس صورت میں خلاصے مختلف کردار ادا کرتے ہیں۔ خلاصے ایک ٹیک ڈوک کے مواد کا خلاصہ پیش کرتے ہیں، لیکن مختلف اقسام یہ کام مختلف طریقوں سے کرتی ہیں:

اگر ایگزیکٹو سمری، تعارف، اور ٹرانسمیٹیل پیغام آپ کو دہرائی دینے والے لگتے ہیں، تو یاد رکھیں کہ قارئین ضروری نہیں کہ ٹیک ڈاک کی شروعات سے شروع کریں اور صفحہ در صفحہ آخر تک پڑھیں۔ وہ اِدھر اُدھر چھان پھٹک کر دیکھتے ہیں: وہ ممکنہ طور پر مواد کی فہرست کو اسکین کرتے ہیں؛ وہ عموماً اہم حقائق اور نتائج کے لیے ایگزیکٹو سمری کو پھرتی سے پڑھتے ہیں۔ وہ ٹیک ڈاک کے مواد میں سے صرف ایک یا دو سیکشن کو بغور پڑھ سکتے ہیں، اور پھر باقی چھوڑ دیتے ہیں۔ ان وجوہات کی بنا پر، ٹیک ڈاک کو کچھ تکرار کے ساتھ ڈیزائن کیا گیا ہے تاکہ قارئین یہ یقینی بنائیں کہ وہ اہم معلومات کو دیکھیں گے چاہے وہ ٹیک ڈاک کے کسی بھی حصے میں کیوں نہ جھانکیں۔


مواد کی فہرست (سب سے پہلے جو آتا ہے) پھر ایگزیکٹو سمری۔

مواد کا جدول

آپ جو بھی مواد کی فہرست (TOC) کا فارمیٹ استعمال کریں، یہ عام معیارات ہیں: