سافٽ ويئر دستاويز صرف آرٽيڪل جو هڪ سيٽ آهي. پر اڃا به اهي توهان کي چريو ڪري سگهن ٿا. پهرين، توهان هڪ ڊگهو وقت گذاريو ضروري هدايتون ڳولڻ لاء. پوء توھان سمجھو ٿا غير واضح متن. توهان ائين ڪريو جيئن لکيو، پر مسئلو حل نه آهي. توهان هڪ ٻيو مضمون ڳوليندا آهيو، توهان پريشان ٿي ويندا آهيو ... هڪ ڪلاڪ بعد توهان سڀ ڪجهه ڇڏي ڏيو ۽ ڇڏي ڏيو. اهو ڪيئن خراب دستاويز ڪم ڪري ٿو. ڇا ان کي هن وانگر بڻائي ٿو ۽ ان کي ڪيئن حل ڪرڻ - ڪٽ جي هيٺان پڙهو.
اسان جي پراڻي دستاويز ۾ ڪيتريون ئي خاميون هيون. اسان ان کي لڳ ڀڳ هڪ سال کان ٻيهر ڪم ڪري رهيا آهيون ته جيئن مٿي بيان ڪيل منظرنامو اسان جي گراهڪن کي متاثر نه ڪري. ڏس، и .
مسئلو 1: غير واضح، ناقص لکيل مضمون
جيڪڏهن دستاويز کي سمجهڻ ناممڪن آهي، ان جو مقصد ڇا آهي؟ پر ڪو به بي مقصد مضمون نه لکندو آهي. اهي تڏهن ٿيندا آهن جڏهن ليکڪ سامعين ۽ مقصد بابت نه سوچيندو آهي، پاڻي ڀريندو آهي ۽ متن کي غلطين جي جانچ نٿو ڪري.
- ليڪچر هال. هڪ مضمون لکڻ کان اڳ، توهان کي پڙهندڙ جي تياري جي سطح بابت سوچڻ جي ضرورت آهي. اهو منطقي آهي ته هڪ مضمون ۾ شروعاتي لاءِ توهان کي بنيادي قدمن کي نه ڇڏڻ گهرجي ۽ بغير وضاحت جي ٽيڪنيڪل اصطلاحن کي ڇڏڻ گهرجي، پر هڪ مضمون ۾ هڪ نادر مضمون جنهن کي صرف ماهرن جي ضرورت آهي، توهان کي لفظ PHP جي معني جي وضاحت ڪرڻ گهرجي.
- گول. اڳ ۾ سوچڻ لاء هڪ ٻي شيء. ليکڪ کي هڪ واضح مقصد مقرر ڪرڻ گهرجي، مضمون جي مفيد اثر کي طئي ڪرڻ گهرجي، ۽ اهو فيصلو ڪرڻ گهرجي ته پڙهندڙ ان کي پڙهڻ کان پوء ڇا ڪندو. جيڪڏهن اهو نه ڪيو ويو آهي، توهان وضاحت جي خاطر وضاحت سان ختم ڪنداسين.
- پاڻي ۽ ڪيڙا. اتي تمام گهڻي غير ضروري معلومات ۽ بيوروڪريسي آهي، غلطيون ۽ ٽائپس تصور ۾ مداخلت ڪن ٿا. جيتوڻيڪ پڙهندڙ گرامر جو نازڪ نه آهي، متن ۾ لاپرواهي کيس بند ڪري سگهي ٿي.
مٿي ڏنل تجويزن تي غور ڪريو، ۽ آرٽيڪل واضح ٿي ويندا - ضمانت. ان کي اڃا به بهتر ڪرڻ لاء، اسان جو استعمال ڪريو .
مسئلو 2. آرٽيڪل سڀني سوالن جا جواب نه ٿا ڏين
اهو خراب آهي جڏهن دستاويز ترقي سان گڏ نه رهي، حقيقي سوالن جو جواب نه ڏئي، ۽ ان ۾ غلطيون سالن تائين درست نه ڪيون ويون آهن. اهي مسئلا ليکڪ جا نه، پر ڪمپني جي اندر عمل جي تنظيم جا آهن.
دستاويز ترقي سان گڏ نه رکندو آھي
مضمون اڳ ۾ ئي جاري آهي، مارڪيٽنگ ان کي ڍڪڻ جو منصوبو آهي، ۽ پوء اهو ظاهر ٿئي ٿو ته نئون مضمون يا ترجمو اڃا تائين دستاويز ۾ ناهي. ان ڪري اسان کي رليز به ملتوي ڪرڻي پئي. توھان ھر ڪنھن کان پڇي سگھو ٿا ڪمن کي ٽيڪنيڪل ليکڪن جي حوالي ڪرڻ لاءِ وقت تي جيترو توھان چاھيو، پر اھو ڪم نه ڪندو. جيڪڏهن عمل خودڪار نه آهي، صورتحال پاڻ کي ورجائي ويندي.
اسان YouTrack ۾ تبديليون ڪيون آھن. نئين مضمون بابت مضمون لکڻ جو ڪم ٽيڪنيڪل ليکڪ کي ان ئي وقت اچي ٿو جڏهن فيچر جي جاچ ٿيڻ شروع ٿئي ٿي. پوءِ مارڪيٽنگ ان جي باري ۾ سکي ٿي پروموشن لاءِ تيار ڪرڻ لاءِ. نوٽيفڪيشن پڻ اچي ٿو Mattermost ڪارپوريٽ ميسينجر، تنهنڪري ڊولپرز کان خبرون وڃائڻ ناممڪن آهي.
دستاويز صارف جي درخواستن کي ظاهر نٿو ڪري
اسان هن طرح ڪم ڪرڻ لاء استعمال ڪيو ويو آهي: هڪ خصوصيت ٻاهر آيو، اسان ان بابت ڳالهايو. اسان بيان ڪيو ته ان کي ڪيئن چالو ڪجي، ان کي بند ڪجي، ۽ ٺيڪ ٺاڪ ٺاھ ڪجي. پر ڇا جيڪڏهن ڪو ڪلائنٽ اسان جي سافٽ ويئر کي اهڙي طريقي سان استعمال ڪري ٿو جنهن جي اسان توقع نه ڪئي هئي؟ يا ڇا ان ۾ غلطيون آهن جن بابت اسان نه سوچيو آهي؟
انهي ڳالهه کي يقيني بڻائڻ لاءِ ته دستاويز جيترو ٿي سگهي مڪمل آهي، اسان تجويز ڪريون ٿا تجزيو ڪرڻ جي حمايت جي درخواستن، موضوعي فورمن تي سوال، ۽ ڳولا انجڻ ۾ سوالن. سڀ کان وڌيڪ مشهور موضوع ٽيڪنيڪل ليکڪن ڏانهن منتقل ڪيا ويندا ته جيئن اهي موجوده مضمونن کي پورو ڪري سگهن يا نوان لکي سگهن.
دستاويز کي بهتر نه ڪيو پيو وڃي
اهو صحيح طور تي مڪمل ڪرڻ ڏکيو آهي؛ اڃا به غلطيون هونديون. توهان گراهڪن کان موٽ جي اميد ڪري سگهو ٿا، پر اهو ممڪن ناهي ته اهي هر ٽائپ، غلط، ناقابل فهم يا اڻ ڄاڻايل مضمون جي رپورٽ ڪندا. گراهڪن جي اضافي ۾، ملازمن کي دستاويز پڙهي ٿو، جنهن جو مطلب آهي ته اهي ساڳيون غلطيون ڏسندا آهن. هي استعمال ڪري سگهجي ٿو! توهان کي صرف اهڙيون حالتون پيدا ڪرڻ جي ضرورت آهي جنهن ۾ اهو مسئلو رپورٽ ڪرڻ آسان ٿي ويندو.
اسان وٽ اندروني پورٽل تي هڪ گروپ آهي جتي ملازمن کي دستاويزن تي تبصرا، تجويزون ۽ خيالن کي ڇڏي ڏيو. ڇا سپورٽ کي آرٽيڪل جي ضرورت آهي، پر اهو موجود ناهي؟ ڇا امتحان ڪندڙ غلطي کي نوٽيس ڪيو؟ ڇا پارٽنر ڊولپمينٽ مينيجرز کي غلطين بابت شڪايت ڪئي آهي؟ هن گروپ ۾ سڀ! ٽيڪنيڪل ليکڪ ڪجهه شيون فوري طور تي درست ڪن ٿا، ڪجهه شيون YouTrack ڏانهن منتقل ڪن ٿا، ۽ ٻين کي سوچڻ لاءِ ڪجهه وقت ڏيو. موضوع کي ختم ٿيڻ کان روڪڻ لاءِ، وقت بوقت اسان توهان کي گروپ جي وجود ۽ راءِ جي اهميت جي ياد ڏياريندا آهيون.
مسئلو 3. صحيح مضمون ڳولڻ ۾ گهڻو وقت لڳندو آهي.
اهڙو مضمون جيڪو نه ملي سگهي، ان کان بهتر نه آهي، جيڪو نه ملي سگهي. سٺي دستاويز جو مقصد هجڻ گهرجي "تلاش ڪرڻ آسان، ڳولڻ ۾ آسان." اهو ڪيئن حاصل ڪجي؟
ڍانچي کي ترتيب ڏيو ۽ موضوع جي چونڊ لاءِ اصول مقرر ڪريو. ساخت کي ممڪن طور تي شفاف هجڻ گهرجي ته جيئن پڙهندڙ اهو نه سوچي، "مان هي مضمون ڪٿي ڳولي سگهان ٿو؟" اختصار ڪرڻ لاء، اتي ٻه طريقا آهن: انٽرفيس کان ۽ ڪمن کان.
- انٽرفيس کان. مواد پينل حصن کي نقل ڪري ٿو. اهو معاملو پراڻي ISPsystem دستاويزن ۾ هو.
- ڪمن کان. مضمونن ۽ حصن جا عنوان صارفين جي ڪمن کي ظاهر ڪن ٿا؛ عنوانن ۾ لڳ ڀڳ هميشه فعل ۽ جوابن تي مشتمل هوندو آهي ”ڪيئن ڪجي“ سوال. هاڻي اسان هن فارميٽ ڏانهن وڌي رهيا آهيون.
جيڪو به طريقو توهان چونڊيو، پڪ ڪريو ته موضوع لاڳاپيل آهي جيڪي صارف ڳولي رهيا آهن ۽ اهڙي طريقي سان ڍڪيل آهي جيڪو خاص طور تي صارف جي سوال کي خطاب ڪري ٿو.
هڪ مرڪزي ڳولا قائم ڪريو. هڪ مثالي دنيا ۾، ڳولها تڏهن به ڪم ڪرڻ گهرجي جڏهن توهان غلط اکر ڪريو يا ٻولي سان غلطي ڪريو. سنگم ۾ اسان جي ڳولا هن وقت تائين اسان کي خوش نه ڪري سگهي ٿي. جيڪڏهن توهان وٽ ڪيترائي پراڊڪٽس آهن ۽ دستاويز عام آهن، ڳولا کي ترتيب ڏيو انهي صفحي تي جيڪو صارف آهي. اسان جي حالت ۾، مکيه صفحي تي ڳولا سڀني شين لاء ڪم ڪري ٿي، ۽ جيڪڏهن توهان اڳ ۾ ئي هڪ مخصوص حصي ۾ آهيو، پوء صرف ان ۾ آرٽيڪل لاء.
مواد ۽ breadcrumbs شامل ڪريو. اهو سٺو آهي جڏهن هر صفحي تي هڪ مينيو ۽ breadcrumbs آهي - استعمال ڪندڙ جو رستو موجوده صفحي ڏانهن ڪنهن به سطح تي موٽڻ جي صلاحيت سان. پراڻي ISPsystem دستاويزن ۾، توهان کي مواد حاصل ڪرڻ لاء آرٽيڪل مان نڪرڻو پوندو. اها تڪليف هئي، تنهنڪري اسان ان کي نئين ۾ مقرر ڪيو.
پراڊڪٽ ۾ لنڪس رکو. جيڪڏهن ماڻهو ساڳئي سوال سان بار بار حمايت ڪرڻ لاء ايندا، اهو انٽرفيس جي حل سان هڪ اشارو شامل ڪرڻ جو احساس آهي. جيڪڏهن توهان وٽ ڊيٽا يا بصيرت آهي جڏهن هڪ صارف ڪنهن مسئلي جو تجربو ڪري رهيو آهي، توهان انهن کي ميلنگ لسٽ سان پڻ مطلع ڪري سگهو ٿا. انھن کي ڳڻتي ڏيکاريو ۽ بار کڻڻ جي حمايت ڪريو.
پاپ اپ ونڊو ۾ ساڄي پاسي ISPmanager جي ڊومين مئنيجمينٽ سيڪشن ۾ DNSSEC قائم ڪرڻ بابت هڪ مضمون جي لنڪ آهي
دستاويزن ۾ ڪراس ريفرنس قائم ڪريو. اهي مضمون جيڪي هڪ ٻئي سان لاڳاپيل هجن ”ڳنڍ“ هجن. جيڪڏهن آرٽيڪل ترتيب وار آهن، هر متن جي آخر ۾ اڳتي ۽ پوئتي تير شامل ڪرڻ جو يقين رکجو.
گهڻو ڪري، هڪ ماڻهو پهريون ڀيرو پنهنجي سوال جو جواب ڳولڻ لاء توهان ڏانهن نه، پر هڪ سرچ انجڻ ڏانهن. اها شرم جي ڳالهه آهي جيڪڏهن ٽيڪنيڪل سببن لاءِ اتي موجود دستاويزن جا لنڪ نه آهن. تنهن ڪري سرچ انجڻ جي اصلاح جو خيال رکجو.
مسئلو 4. پراڻي ترتيب تصور ۾ مداخلت ڪري ٿي
خراب نصوص جي اضافي ۾، دستاويز کي ڊزائين ذريعي خراب ڪري سگهجي ٿو. ماڻهو سٺو لکيل مواد پڙهڻ جا عادي آهن. بلاگ، سماجي نيٽ ورڪ، ميڊيا - سڀ مواد پيش ڪيو ويو آهي نه رڳو خوبصورت، پر پڻ پڙهڻ لاء آسان ۽ اکين کي خوش ڪرڻ. تنهن ڪري، توهان آساني سان سمجهي سگهو ٿا هڪ شخص جو درد جيڪو هيٺ ڏنل اسڪرين شاٽ وانگر متن ڏسي ٿو.
ھن آرٽيڪل ۾ ڪيترائي اسڪرين شاٽ ۽ نمايان آھن جيڪي مدد نه ڪندا آھن، پر رڳو تاثر ۾ مداخلت ڪندا آھن (تصوير ڪلڪ ڪرڻ لائق آھي)
توھان کي دستاويزن مان ڊگھي پڙھڻ نه گھرجي اثرات جي ھڪڙي گروپ سان، پر توھان کي حساب ۾ رکڻ گھرجي بنيادي اصولن کي.
ترتيب. جسم جي متن جي چوٽي، فونٽ، سائيز، عنوان، ۽ پيڊنگ جو اندازو لڳايو. ڪنهن ڊزائنر کي گهرايو، ۽ ڪم کي قبول ڪرڻ لاءِ يا اهو پاڻ ڪرڻ لاءِ، پڙهو آرٽيوم گوربنوف جو ڪتاب ”ٽائپوگرافي ۽ لي آئوٽ“. اهو صرف هڪ منظر پيش ڪري ٿو ترتيب جو، پر اهو ڪافي آهي.
مختص. وضاحت ڪريو ته متن ۾ زور ڏيڻ جي ڪهڙي ضرورت آهي. عام طور تي هي هڪ رستو آهي انٽرفيس ۾، بٽڻ، ڪوڊ داخل ڪرڻ، ترتيب ڏيڻ واريون فائلون، "مهرباني ڪري نوٽ ڪريو" بلاڪ. اهو طئي ڪيو ته انهن عناصر جي تخصيص ڇا هوندي ۽ انهن کي ضابطن ۾ رڪارڊ ڪيو ويندو. ذهن ۾ رکو ته گهٽ خارج ٿيڻ، بهتر. جڏهن انهن مان گهڻا آهن، متن شور آهي. جيتوڻيڪ اقتباس جا نشان شور ٺاهيندا آهن جيڪڏهن اهي اڪثر استعمال ڪيا وڃن.
اسڪرين شاٽ. ٽيم سان متفق ٿيو ڪهڙن ڪيسن ۾ اسڪرين شاٽ جي ضرورت آهي. هر قدم کي واضح ڪرڻ جي ضرورت ناهي. اسڪرين شاٽ جو وڏو تعداد، بشمول. الڳ بٽڻ، تصور سان مداخلت، ترتيب خراب ڪريو. سائيز جو تعين ڪريو، گڏوگڏ نمايان ۽ نشانين جي شڪل اسڪرين شاٽ تي، ۽ انھن کي ضابطن ۾ رڪارڊ ڪريو. ياد رکو ته عڪس هميشه انهي سان ملن ٿا جيڪي لکيل آهن ۽ لاڳاپيل هجن. ٻيهر، جيڪڏهن پيداوار باقاعدي طور تي اپڊيٽ ڪيو ويندو آهي، اهو هر ڪنهن جي ٽريڪ رکڻ ڏکيو ٿيندو.
متن جي ڊيگهه. ڊگھي مضمونن کان پاسو ڪريو. انھن کي حصن ۾ ورهايو، ۽ جيڪڏھن اھو ممڪن نه آھي، مضمون جي شروعات ۾ لنگر لنڪ سان مواد شامل ڪريو. مضمون کي بصري طور ننڍو ڪرڻ جو هڪ سادو طريقو آهي ٽيڪنيڪل تفصيلن کي لڪائڻ لاءِ جنهن کي پڙهندڙن جي هڪ تنگ دائري کي اسپائلر هيٺان گهربل هجي.
فارميٽ. توهان جي مضمونن ۾ ڪيترن ئي فارميٽ کي گڏ ڪريو: متن، وڊيو ۽ تصويرون. اهو تصور کي بهتر بڻائي ٿو.
خوبصورت ترتيب سان مسئلن کي ڍڪڻ جي ڪوشش نه ڪريو. ايمانداري سان، اسان پاڻ کي اميد هئي ته "ريپر" پراڻي دستاويز کي بچائيندو - اهو ڪم نه ڪيو. نصوص ايترو ته بصري شور ۽ غير ضروري تفصيلن تي مشتمل هو ته ضابطا ۽ نئين ڊيزائن بي طاقت هئا.
مٿين مان گهڻو ڪجهه طئي ڪيو ويندو پليٽ فارم طرفان جيڪو توهان دستاويزن لاءِ استعمال ڪندا آهيو. مثال طور، اسان وٽ سنگم آهي. مون کي به هن سان ٽڪرائڻو پيو. جيڪڏهن دلچسپي رکو، اسان جي ويب ڊولپر جي ڪهاڻي پڙهو: .
ڪٿي بهتري شروع ڪجي ۽ ڪيئن بچجي
جيڪڏهن توهان جو دستاويز ISPsystem جي جيترو وسيع آهي ۽ توهان کي خبر ناهي ته ڪٿان شروع ڪجي، سڀ کان وڏي مسئلن سان شروع ڪريو. گراهڪ دستاويز نه سمجھندا آھن - نصوص کي بهتر ڪريو، ضابطا ٺاھيو، ليکڪن کي تربيت ڏيو. دستاويزي تاريخ کان ٻاهر آهي - اندروني عملن جو خيال رکجو. سڀ کان وڌيڪ مشهور پراڊڪٽس بابت سڀ کان وڌيڪ مشهور مضمونن سان شروع ڪريو: مدد لاء پڇو، سائيٽ اينالائيٽڪس تي ڏسو ۽ ڳولا انجڻ ۾ سوال.
اچو ته فوري طور تي چئو - اهو آسان نه ٿيندو. ۽ اهو جلدي ڪم ڪرڻ ممڪن ناهي. جيستائين توهان صرف شروع ڪري رهيا آهيو ۽ صحيح ڪم ڪريو. ھڪڙي شيء جيڪا اسان ڄاڻون ٿا پڪ سان اھو آھي ته اھو وقت سان بھتر ٿيندو. پر اهو عمل ڪڏهن به ختم نه ٿيندو :-).
جو ذريعو: www.habr.com