سافٹ ویئر دستاویزات صرف مضامین کا ایک مجموعہ ہے۔ لیکن یہاں تک کہ وہ آپ کو پاگل بنا سکتے ہیں۔ سب سے پہلے، آپ ضروری ہدایات کی تلاش میں ایک طویل وقت خرچ کرتے ہیں. پھر آپ غیر واضح متن کو سمجھتے ہیں۔ آپ جیسا لکھا ہوا کرتے ہیں، لیکن مسئلہ حل نہیں ہوتا۔ آپ ایک اور مضمون تلاش کرتے ہیں، آپ گھبرا جاتے ہیں... ایک گھنٹے بعد آپ سب کچھ ترک کر کے چلے جاتے ہیں۔ اس طرح خراب دستاویزات کام کرتی ہیں۔ اسے اس طرح کیا بناتا ہے اور اسے کیسے ٹھیک کرنا ہے - کٹ کے نیچے پڑھیں۔
ہماری پرانی دستاویزات میں بہت سی کوتاہیاں تھیں۔ ہم تقریباً ایک سال سے اس پر دوبارہ کام کر رہے ہیں تاکہ اوپر بیان کردہ منظر نامہ ہمارے کلائنٹس کو متاثر نہ کرے۔ دیکھو и .
مسئلہ 1: غیر واضح، ناقص تحریری مضامین
اگر دستاویزات کو سمجھنا ناممکن ہے تو اس کا کیا فائدہ؟ لیکن کوئی بھی جان بوجھ کر ناقابل فہم مضامین نہیں لکھتا۔ یہ تب ہوتا ہے جب مصنف سامعین اور مقصد کے بارے میں نہیں سوچتا، پانی ڈالتا ہے اور متن کی غلطیوں کی جانچ نہیں کرتا ہے۔
- سامعین. مضمون لکھنے سے پہلے، آپ کو قارئین کی تیاری کی سطح کے بارے میں سوچنا ہوگا۔ یہ منطقی ہے کہ ایک ابتدائی کے لیے ایک مضمون میں آپ کو بنیادی مراحل کو نہیں چھوڑنا چاہیے اور بغیر وضاحت کے تکنیکی اصطلاحات کو چھوڑنا چاہیے، لیکن ایک نایاب خصوصیت کے مضمون میں جس کی صرف پیشہ ور افراد کو ضرورت ہے، آپ کو لفظ PHP کے معنی کی وضاحت کرنی چاہیے۔
- گول. ایک اور چیز کے بارے میں پہلے سے سوچنا ہے۔ مصنف کو ایک واضح ہدف طے کرنا چاہیے، مضمون کے مفید اثر کا تعین کرنا چاہیے، اور فیصلہ کرنا چاہیے کہ پڑھنے کے بعد قاری کیا کرے گا۔ اگر ایسا نہیں کیا گیا تو، آپ وضاحت کی خاطر وضاحت کے ساتھ ختم ہوجائیں گے۔
- پانی اور کیڑے. بہت ساری غیر ضروری معلومات اور بیوروکریسی ہے، غلطیاں اور ٹائپ کی غلطیاں تاثر میں مداخلت کرتی ہیں۔ قاری گرائمر نازی نہ ہو تب بھی متن میں لاپرواہی اسے بند کر سکتی ہے۔
مندرجہ بالا تجاویز پر غور کریں، اور مضامین واضح ہو جائیں گے - ضمانت دی گئی ہے. اسے اور بھی بہتر بنانے کے لیے، ہمارا استعمال کریں۔ .
مسئلہ 2. مضامین تمام سوالات کے جواب نہیں دیتے
یہ برا ہے جب دستاویزات ترقی کے ساتھ نہیں رہتی ہیں، حقیقی سوالات کا جواب نہیں دیتی ہیں، اور اس میں غلطیوں کو سالوں تک درست نہیں کیا جاتا ہے۔ یہ مسائل مصنف کے نہیں بلکہ کمپنی کے اندر عمل کی تنظیم کے ہیں۔
دستاویزات ترقی کے ساتھ نہیں رہتی ہیں۔
فیچر پہلے ہی ریلیز میں ہے، مارکیٹنگ اس کا احاطہ کرنے کا ارادہ رکھتی ہے، اور پھر پتہ چلتا ہے کہ نیا مضمون یا ترجمہ ابھی بھی دستاویزات میں نہیں ہے۔ یہاں تک کہ ہمیں اس کی وجہ سے ریلیز ملتوی کرنا پڑی۔ آپ ہر ایک سے کہہ سکتے ہیں کہ آپ جتنا چاہیں وقت پر تکنیکی مصنفین کو کام سونپ دیں، لیکن یہ کام نہیں کرے گا۔ اگر یہ عمل خودکار نہیں ہے تو صورتحال خود کو دہرائے گی۔
ہم نے YouTrack میں تبدیلیاں کی ہیں۔ کسی نئی خصوصیت کے بارے میں مضمون لکھنے کا کام تکنیکی مصنف پر اسی لمحے آتا ہے جب اس فیچر کی جانچ شروع ہوتی ہے۔ پھر مارکیٹنگ اس کے بارے میں سیکھتی ہے تاکہ پروموشن کی تیاری کی جا سکے۔ نوٹیفکیشنز بھی Mattermost کارپوریٹ میسنجر پر آتی ہیں، اس لیے ڈویلپرز کی خبروں سے محروم ہونا ناممکن ہے۔
دستاویزات صارف کی درخواستوں کی عکاسی نہیں کرتی ہیں۔
ہم اس طرح کام کرنے کے عادی ہیں: ایک خصوصیت سامنے آئی، ہم نے اس کے بارے میں بات کی۔ ہم نے اسے آن کرنے، اسے آف کرنے اور عمدہ ایڈجسٹمنٹ کرنے کا طریقہ بتایا ہے۔ لیکن کیا ہوگا اگر کوئی کلائنٹ ہمارے سافٹ ویئر کو اس طرح استعمال کرتا ہے جس کی ہمیں توقع نہیں تھی؟ یا اس میں ایسی غلطیاں ہیں جن کے بارے میں ہم نے سوچا بھی نہیں؟
اس بات کو یقینی بنانے کے لیے کہ دستاویزات ممکن حد تک مکمل ہوں، ہم سپورٹ کی درخواستوں، موضوعاتی فورمز پر سوالات، اور سرچ انجنوں میں سوالات کا تجزیہ کرنے کی تجویز کرتے ہیں۔ سب سے زیادہ مقبول موضوعات تکنیکی مصنفین کو منتقل کیے جائیں گے تاکہ وہ موجودہ مضامین کی تکمیل کر سکیں یا نئے لکھ سکیں۔
دستاویزات کو بہتر نہیں کیا جا رہا ہے۔
اسے ابھی مکمل طور پر کرنا مشکل ہے؛ اب بھی غلطیاں ہوں گی۔ آپ گاہکوں سے تاثرات کی امید کر سکتے ہیں، لیکن اس بات کا امکان نہیں ہے کہ وہ ہر ٹائپنگ، غلط، ناقابل فہم یا بے بنیاد مضمون کی اطلاع دیں گے۔ کلائنٹس کے علاوہ، ملازمین دستاویزات پڑھتے ہیں، جس کا مطلب ہے کہ وہ وہی غلطیاں دیکھتے ہیں۔ یہ استعمال کیا جا سکتا ہے! آپ کو صرف ایسے حالات پیدا کرنے کی ضرورت ہے جس میں کسی مسئلے کی اطلاع دینا آسان ہو۔
ہمارے اندرونی پورٹل پر ایک گروپ ہے جہاں ملازمین دستاویزات پر تبصرے، تجاویز اور خیالات چھوڑتے ہیں۔ کیا سپورٹ کو ایک مضمون کی ضرورت ہے، لیکن یہ موجود نہیں ہے؟ کیا ٹیسٹر نے غلطی کا نوٹس لیا؟ کیا پارٹنر نے ترقیاتی مینیجرز سے غلطیوں کی شکایت کی ہے؟ اس گروپ میں سب! تکنیکی مصنفین کچھ چیزوں کو فوراً ٹھیک کرتے ہیں، کچھ چیزوں کو YouTrack میں منتقل کرتے ہیں، اور دوسروں کو سوچنے کے لیے کچھ وقت دیتے ہیں۔ موضوع کو ختم ہونے سے روکنے کے لیے، ہم وقتاً فوقتاً آپ کو گروپ کے وجود اور تاثرات کی اہمیت کی یاد دلاتے رہتے ہیں۔
مسئلہ 3۔ صحیح مضمون تلاش کرنے میں کافی وقت لگتا ہے۔
ایک مضمون جو نہیں مل سکتا اس مضمون سے بہتر نہیں ہے جو نہ مل سکے۔ اچھی دستاویزات کا نعرہ "تلاش کرنے میں آسان، تلاش کرنے میں آسان" ہونا چاہیے۔ اس کو کیسے حاصل کیا جائے؟
ڈھانچے کو منظم کریں اور عنوانات کے انتخاب کے لیے اصول کا تعین کریں۔. ڈھانچہ ہر ممکن حد تک شفاف ہونا چاہیے تاکہ قاری یہ نہ سوچے، "مجھے یہ مضمون کہاں سے مل سکتا ہے؟" خلاصہ کرنے کے لیے، دو طریقے ہیں: انٹرفیس سے اور کاموں سے۔
- انٹرفیس سے۔ مواد پینل کے حصوں کو نقل کرتا ہے۔ پرانے آئی ایس پی سسٹم دستاویزات میں یہ معاملہ تھا۔
- کاموں سے۔ مضامین اور حصوں کے عنوانات صارفین کے کاموں کی عکاسی کرتے ہیں۔ عنوانات میں تقریبا ہمیشہ فعل اور "کیسے" سوال کے جوابات ہوتے ہیں۔ اب ہم اس فارمیٹ کی طرف بڑھ رہے ہیں۔
آپ جو بھی نقطہ نظر منتخب کرتے ہیں، اس بات کو یقینی بنائیں کہ موضوع اس سے متعلقہ ہے جو صارفین تلاش کر رہے ہیں اور اس کا احاطہ اس طریقے سے کیا گیا ہے جو خاص طور پر صارف کے سوال کو حل کرے۔
ایک مرکزی تلاش ترتیب دیں۔. ایک مثالی دنیا میں، تلاش اس وقت بھی کام کرے جب آپ غلط ہجے کرتے ہیں یا زبان میں غلطی کرتے ہیں۔ سنگم میں ہماری تلاش اب تک ہمیں اس سے خوش نہیں کر سکتی۔ اگر آپ کے پاس بہت سے پروڈکٹس ہیں اور دستاویزات عام ہیں، تو صارف جس صفحہ پر ہے اس کے مطابق تلاش کریں۔ ہمارے معاملے میں، مرکزی صفحہ پر تلاش تمام مصنوعات کے لیے کام کرتی ہے، اور اگر آپ پہلے سے ہی کسی مخصوص حصے میں ہیں، تو صرف اس میں موجود مضامین کے لیے۔
مواد اور بریڈ کرمبس شامل کریں۔. یہ اچھا ہے جب ہر صفحہ میں ایک مینو اور بریڈ کرمبس ہوں - کسی بھی سطح پر واپس جانے کی صلاحیت کے ساتھ موجودہ صفحہ تک صارف کا راستہ۔ پرانے ISPsystem دستاویزات میں، آپ کو مواد تک پہنچنے کے لیے مضمون سے باہر نکلنا پڑا۔ یہ تکلیف دہ تھا، لہذا ہم نے اسے نئے میں ٹھیک کیا۔
پروڈکٹ میں لنکس لگائیں۔. اگر لوگ ایک ہی سوال کے ساتھ بار بار حمایت کرتے ہیں، تو انٹرفیس میں اس کے حل کے ساتھ اشارہ شامل کرنا سمجھ میں آتا ہے۔ اگر آپ کے پاس ڈیٹا یا بصیرت ہے کہ صارف کب کسی مسئلے کا سامنا کر رہا ہے، تو آپ انہیں میلنگ لسٹ کے ساتھ بھی مطلع کر سکتے ہیں۔ انہیں تشویش دکھائیں اور بوجھ کو سہارا دیں۔
پاپ اپ ونڈو میں دائیں طرف ISPmanager کے ڈومین مینجمنٹ سیکشن میں DNSSEC کو ترتیب دینے کے بارے میں ایک مضمون کا لنک ہے۔
دستاویزات کے اندر کراس حوالہ جات مرتب کریں۔. وہ مضامین جو ایک دوسرے سے متعلق ہیں "منسلک" ہونے چاہئیں۔ اگر مضامین ترتیب وار ہیں، تو ہر متن کے آخر میں آگے اور پیچھے کی طرف تیر شامل کرنا نہ بھولیں۔
زیادہ تر امکان ہے کہ ایک شخص پہلے اپنے سوال کا جواب آپ کے پاس نہیں بلکہ سرچ انجن کے پاس تلاش کرے گا۔ اگر تکنیکی وجوہات کی بناء پر وہاں دستاویزات کا کوئی لنک نہیں ہے تو یہ شرم کی بات ہے۔ اس لیے سرچ انجن آپٹیمائزیشن کا خیال رکھیں۔
مسئلہ 4۔ پرانی ترتیب تصور میں مداخلت کرتی ہے۔
خراب متن کے علاوہ، دستاویزات کو ڈیزائن کے ذریعہ خراب کیا جاسکتا ہے۔ لوگ اچھی طرح سے لکھا ہوا مواد پڑھنے کے عادی ہیں۔ بلاگز، سوشل نیٹ ورکس، میڈیا - تمام مواد نہ صرف خوبصورت پیش کیا جاتا ہے، بلکہ پڑھنے میں آسان اور آنکھوں کو خوش کرنے والا بھی ہوتا ہے۔ لہذا، آپ آسانی سے اس شخص کے درد کو سمجھ سکتے ہیں جو نیچے اسکرین شاٹ کی طرح متن دیکھتا ہے۔
اس آرٹیکل میں بہت سارے اسکرین شاٹس اور جھلکیاں ہیں کہ وہ مدد نہیں کرتے ہیں، لیکن صرف خیال میں مداخلت کرتے ہیں (تصویر قابل کلک ہے)
آپ کو اثرات کے ایک گروپ کے ساتھ دستاویزات سے طویل مطالعہ نہیں کرنا چاہئے، لیکن آپ کو بنیادی اصولوں کو مدنظر رکھنا ہوگا۔
ترتیب. جسم کے متن کی چوڑائی، فونٹ، سائز، عنوانات، اور پیڈنگ کا تعین کریں۔ ایک ڈیزائنر کی خدمات حاصل کریں، اور کام کو قبول کرنے یا خود کرنے کے لیے، آرٹیوم گوربونوف کی کتاب "ٹائپوگرافی اور لے آؤٹ" پڑھیں۔ یہ ترتیب کا صرف ایک منظر پیش کرتا ہے، لیکن یہ کافی ہے۔
مختص. اس بات کا تعین کریں کہ متن میں کس چیز پر زور دینے کی ضرورت ہے۔ عام طور پر یہ انٹرفیس، بٹن، کوڈ انسرٹس، کنفیگریشن فائلز، "براہ کرم نوٹ کریں" بلاکس کا راستہ ہے۔ اس بات کا تعین کریں کہ ان عناصر کی مختصات کیا ہوں گی اور انہیں ضوابط میں درج کریں۔ ذہن میں رکھیں کہ کم خارج ہونے والے مادہ، بہتر. جب ان میں سے بہت سارے ہوتے ہیں تو متن میں شور ہوتا ہے۔ یہاں تک کہ کوٹیشن مارکس بھی شور پیدا کرتے ہیں اگر وہ کثرت سے استعمال ہوتے ہیں۔
سکرینشاٹ. ٹیم سے اتفاق کریں کہ کن صورتوں میں اسکرین شاٹس کی ضرورت ہے۔ یقینی طور پر ہر قدم کی مثال دینے کی ضرورت نہیں ہے۔ اسکرین شاٹس کی ایک بڑی تعداد، بشمول۔ بٹن الگ کریں، ادراک میں مداخلت کریں، ترتیب کو خراب کریں۔ سائز کا تعین کریں، نیز اسکرین شاٹس پر جھلکیوں اور دستخطوں کی شکل کا تعین کریں، اور انہیں ضوابط میں ریکارڈ کریں۔ یاد رکھیں کہ مثالیں ہمیشہ لکھی ہوئی چیزوں کے مطابق ہونی چاہئیں اور متعلقہ ہونی چاہئیں۔ ایک بار پھر، اگر پروڈکٹ کو باقاعدگی سے اپ ڈیٹ کیا جاتا ہے، تو ہر ایک پر نظر رکھنا مشکل ہو جائے گا۔
متن کی لمبائی. زیادہ لمبے مضامین سے پرہیز کریں۔ انہیں حصوں میں توڑ دیں، اور اگر ممکن نہ ہو تو مضمون کے آغاز میں اینکر لنکس کے ساتھ مواد شامل کریں۔ کسی مضمون کو بصری طور پر چھوٹا بنانے کا ایک آسان طریقہ یہ ہے کہ قارئین کے ایک تنگ دائرے کے لیے درکار تکنیکی تفصیلات کو ایک بگاڑنے والے کے نیچے چھپانا جائے۔
فارمیٹس. اپنے مضامین میں متعدد فارمیٹس کو یکجا کریں: متن، ویڈیو اور تصاویر۔ اس سے ادراک میں بہتری آئے گی۔
خوبصورت ترتیب کے ساتھ مسائل کو چھپانے کی کوشش نہ کریں۔ سچ میں، ہم نے خود امید کی تھی کہ "ریپر" فرسودہ دستاویزات کو محفوظ کر لے گا - یہ کام نہیں ہوا۔ متن میں اتنا بصری شور اور غیر ضروری تفصیلات موجود تھیں کہ ضابطے اور نئے ڈیزائن بے اختیار تھے۔
مندرجہ بالا میں سے زیادہ تر کا تعین اس پلیٹ فارم سے کیا جائے گا جسے آپ دستاویزات کے لیے استعمال کرتے ہیں۔ مثال کے طور پر، ہمارے پاس سنگم ہے۔ مجھے بھی اس کے ساتھ ٹنکر کرنا پڑا۔ اگر دلچسپی ہے تو، ہمارے ویب ڈویلپر کی کہانی پڑھیں: .
کہاں سے بہتر ہونا شروع کیا جائے اور کیسے زندہ رہنا ہے۔
اگر آپ کی دستاویزات اتنی ہی وسیع ہیں جتنی ISPsystem کی اور آپ نہیں جانتے کہ کہاں سے شروع کرنا ہے، سب سے بڑے مسائل سے شروع کریں۔ کلائنٹس دستاویز کو نہیں سمجھتے - متن کو بہتر بنائیں، قواعد و ضوابط بنائیں، مصنفین کو تربیت دیں۔ دستاویزات پرانی ہیں - اندرونی عمل کا خیال رکھیں۔ سب سے زیادہ مقبول مصنوعات کے بارے میں سب سے زیادہ مقبول مضامین کے ساتھ شروع کریں: مدد طلب کریں، تلاش کے انجن میں سائٹ کے تجزیات اور سوالات دیکھیں۔
چلو فوراً کہتے ہیں - یہ آسان نہیں ہوگا۔ اور یہ بھی جلدی کام کرنے کا امکان نہیں ہے۔ جب تک کہ آپ ابھی شروعات نہیں کر رہے ہیں اور ابھی صحیح کام کر رہے ہیں۔ ایک چیز جو ہم یقینی طور پر جانتے ہیں وہ یہ ہے کہ یہ وقت کے ساتھ ساتھ بہتر ہوتا جائے گا۔ لیکن یہ عمل کبھی ختم نہیں ہوگا :-)۔
ماخذ: www.habr.com