د سافټویر اسناد یوازې د مقالو یوه مجموعه ده. مګر حتی دوی کولی شي تاسو لیونی کړي. لومړی، تاسو د اړینو لارښوونو په لټه کې ډیر وخت مصرف کوئ. بیا تاسو ناڅرګند متن پوهیږئ. تاسو لکه څنګه چې لیکل شوي وي، مګر ستونزه نه حل کیږي. تاسو بله مقاله ګورئ، تاسو اضطراب کوئ ... یو ساعت وروسته تاسو هرڅه پریږدئ او پریږدئ. دا څنګه خراب اسناد کار کوي. دا څه شی جوړوي او دا څنګه حل کوي - د کټ لاندې ولولئ.
زموږ په پخوانیو اسنادو کې ډیری نیمګړتیاوې وې. موږ دا د نږدې یو کال راهیسې بیا کار کوو ترڅو پورته بیان شوي سناریو زموږ په پیرودونکو اغیزه ونکړي. وګوره и .
ستونزه 1: ناڅرګنده، خراب لیکل شوي مقالې
که د اسنادو پوهیدل ناشونی وي، نو د دې معنی څه ده؟ مګر هیڅوک په قصدي ډول د نه پوهیدو وړ مقالې نه لیکي. دا هغه وخت پیښیږي کله چې لیکوال د لیدونکو او هدف په اړه فکر نه کوي، اوبه تویوي او متن د غلطیو لپاره نه ګوري.
- اورېدونکي. د مقالې لیکلو دمخه ، تاسو اړتیا لرئ د لوستونکي چمتووالي کچې په اړه فکر وکړئ. دا منطقي ده چې د پیل کونکي لپاره په مقاله کې تاسو باید لومړني مرحلې پریږدئ او پرته له توضیحي تخنیکي شرایط پریږدئ ، مګر په یوه مقاله کې د نادر خصوصیت په اړه چې یوازې مسلکیان ورته اړتیا لري ، تاسو باید د PHP کلمې معنی تشریح کړئ.
- هدف. یو بل شی چې مخکې یې فکر وکړئ. لیکوال باید روښانه هدف وټاکي، د مقالې ګټور اثر وټاکي او پریکړه وکړي چې لوستونکی به یې له لوستلو وروسته څه وکړي. که دا نه وي ترسره شوي، تاسو به د تفصیل لپاره د توضیحاتو سره پای ته ورسیږئ.
- اوبه او کیګونه. ډیری غیر ضروري معلومات او بیوروکراسي شتون لري، غلطۍ او ټایپونه د مفهوم سره مداخله کوي. حتی که لوستونکی د ګرامر ناجي نه وي، په متن کې بې پروايي کولی شي هغه بند کړي.
پورته لارښوونې په پام کې ونیسئ، او مقالې به روښانه شي - تضمین شوی. د دې لا ښه کولو لپاره زموږ څخه کار واخلئ .
ستونزه 2. مقالې ټولو پوښتنو ته ځواب نه ورکوي
دا بد دی کله چې اسناد د پرمختګ سره دوام ونلري، اصلي پوښتنو ته ځواب نه ورکوي، او په دې کې تېروتنې د کلونو لپاره نه اصلاح کیږي. دا ستونزې د لیکوال دومره نه دي، بلکې په شرکت کې د پروسو تنظیم کول دي.
اسناد د پرمختګ سره نه ساتي
فیچر لا دمخه په خپریدو کې دی، بازار موندنه پالن لري چې دا پوښ کړي، او بیا دا معلومه شوه چې نوې مقاله یا ژباړه لاهم په اسنادو کې نه ده. موږ حتی د دې له امله خوشې کول وځنډول. تاسو کولی شئ له هرچا څخه وغواړئ چې تخنیکي لیکوالانو ته په وخت سره دندې وسپاري څومره چې تاسو غواړئ، مګر دا به کار ونکړي. که پروسه اتومات نه وي، وضعیت به بیا تکرار شي.
موږ په YouTrack کې بدلونونه کړي دي. د نوي فیچر په اړه د مقالې لیکلو دنده په ورته شیبه کې تخنیکي لیکوال ته راځي کله چې د فیچر ازموینه پیل شي. بیا بازار موندنه د دې په اړه زده کړه کوي ترڅو د ترویج لپاره چمتو شي. خبرتیاوې د میټرموسټ کارپوریټ میسنجر ته هم راځي ، نو د پراختیا کونکو څخه خبرونه له لاسه ورکول په ساده ډول ناممکن دي.
اسناد د کارونکي غوښتنې نه منعکس کوي
موږ د دې په څیر کار کولو ته عادت شوي یو: یو ځانګړتیا راوتلې، موږ د هغې په اړه خبرې وکړې. موږ تشریح کړل چې څنګه یې چالان کړو، بند یې کړو، او ښه سمونونه وکړو. مګر څه که چیرې یو پیرودونکی زموږ سافټویر په داسې طریقه کاروي چې موږ یې تمه نه درلوده؟ یا ایا دا غلطۍ لري چې موږ یې په اړه فکر نه کاوه؟
د دې لپاره چې ډاډ ترلاسه شي چې اسناد د امکان تر حده بشپړ دي، موږ وړاندیز کوو چې د ملاتړ غوښتنې تحلیل کړئ، په موضوعي فورمونو کې پوښتنې، او د لټون انجنونو کې پوښتنې. خورا مشهور موضوعات به تخنیکي لیکوالانو ته لیږدول کیږي ترڅو دوی وکولی شي موجوده مقالې ضمیمه کړي یا نوې لیکنې ولیکي.
اسناد ښه نه کیږي
دا ستونزمنه ده چې دا سمدلاسه ترسره کړئ؛ بیا به هم غلطي وي. تاسو کولی شئ د پیرودونکو څخه د فیډبیک تمه وکړئ، مګر دا امکان نلري چې دوی به د هر ټایپ، غلطۍ، نه پوهیدو یا بې بنسټه مقالې راپور ورکړي. د پیرودونکو سربیره، کارمندان اسناد لولي، پدې معنی چې دوی ورته غلطی ګوري. دا کارول کیدی شي! تاسو یوازې اړتیا لرئ داسې شرایط رامینځته کړئ چې په هغه کې به د ستونزې راپور ورکول اسانه وي.
موږ په داخلي پورټل کې یوه ډله لرو چیرې چې کارمندان د اسنادو په اړه نظرونه، وړاندیزونه او نظریات پریږدي. ایا ملاتړ یوې مقالې ته اړتیا لري، مګر دا شتون نلري؟ ایا ټیسټر غلطۍ ته پام کړی؟ ایا ملګري د پرمختیا مدیرانو ته د غلطیو په اړه شکایت کړی؟ ټول په دې ګروپ کې! تخنیکي لیکوالان ځینې شیان سمدلاسه حل کوي، ځینې شیان YouTrack ته لیږدوي، او نورو ته د فکر کولو لپاره یو څه وخت ورکوي. د دې لپاره چې موضوع له مینځه لاړه شي، وخت په وخت موږ تاسو ته د ډلې شتون او د فیډبیک اهمیت یادونه کوو.
ستونزه 3. د سمې مقالې موندلو لپاره ډیر وخت نیسي.
هغه مقاله چې نه موندل کیږي د هغه مقالې څخه غوره نه ده چې نه موندل کیږي. د ښه اسنادو شعار باید "د لټون لپاره اسانه، موندل اسانه وي." دا څنګه ترلاسه کول؟
جوړښت تنظیم کړئ او د موضوعاتو غوره کولو لپاره اصول وټاکئ. جوړښت باید د امکان تر حده شفاف وي ترڅو لوستونکی فکر ونه کړي، "زه دا مقاله چیرته موندلی شم؟" د لنډیز لپاره، دوه لارې شتون لري: د انٹرفیس څخه او د دندو څخه.
- د انٹرفیس څخه. مینځپانګه د پینل برخې نقل کوي. دا په زاړه ISP سیسټم اسنادو کې قضیه وه.
- د دندو څخه. د مقالو او برخو سرلیکونه د کاروونکو دندې منعکس کوي؛ سرلیکونه تقریبا تل د "څنګه" پوښتنې ته فعلونه او ځوابونه لري. اوس موږ دې شکل ته ځو.
هر هغه طریقه چې تاسو غوره کوئ، ډاډ ترلاسه کړئ چې موضوع د هغه څه سره تړاو لري چې کاروونکي یې په لټه کې دي او په داسې طریقه پوښل شوي چې په ځانګړې توګه د کاروونکي پوښتنې ته ځواب ووایي.
یو مرکزي لټون تنظیم کړئ. په یوه مثالي نړۍ کې، لټون باید کار وکړي حتی کله چې تاسو د ژبې سره خطا یا غلطي کوئ. تر دې دمه په کنفلونس کې زموږ لټون موږ له دې سره خوښ نه کړو. که تاسو ډیری محصولات لرئ او اسناد عمومي دي، لټون هغه پاڼې ته تنظیم کړئ چې کارونکي یې پر مخ دي. زموږ په قضیه کې، په اصلي پاڼه کې لټون د ټولو محصولاتو لپاره کار کوي، او که تاسو دمخه په یوه ځانګړې برخه کې یاست، نو یوازې د دې مقالو لپاره.
مواد او د ډوډۍ ټوټې اضافه کړئ. دا ښه ده کله چې هره پاڼه یو مینو او د ډوډۍ ټوټې ولري - د کارونکي لاره اوسني پاڼې ته د دې وړتیا سره چې هرې کچې ته بیرته راستانه شي. په زاړه ISP سیسټم اسنادو کې ، تاسو باید مینځپانګې ته د رسیدو لپاره مقاله پریږدئ. دا ناامنه وه، نو موږ دا په نوي کې تنظیم کړه.
په محصول کې لینکونه ځای په ځای کړئ. که خلک د ورته پوښتنې سره بار بار ملاتړ ته راشي ، نو دا معنی لري چې انٹرفیس ته د دې حل سره اشاره اضافه کړئ. که تاسو ډاټا یا بصیرت لرئ کله چې یو کاروونکي د ستونزې سره مخ وي، تاسو کولی شئ دوی ته د بریښنالیک لیست سره خبر ورکړئ. دوی ته اندیښنه وښایاست او د ملاتړ څخه بار واخلئ.
په پاپ اپ کړکۍ کې ښي خوا ته د ISPmanager د ډومین مدیریت برخې کې د DNSSEC تنظیم کولو په اړه د یوې مقالې لینک دی
په اسنادو کې د کراس حوالې تنظیم کړئ. هغه مقالې چې یو له بل سره تړاو لري باید "تړل" وي. که مقالې په ترتیب سره وي، ډاډ ترلاسه کړئ چې د هر متن په پای کې مخکې او شاته تیرونه اضافه کړئ.
ډیری احتمال، یو سړی به لومړی د خپلې پوښتنې ځواب په لټه کې وي تاسو ته نه، مګر د لټون انجن ته. دا د شرم خبره ده که چیرې د تخنیکي دلایلو لپاره د اسنادو سره اړیکې شتون نلري. نو د لټون انجن اصلاح کولو ته پاملرنه وکړئ.
ستونزه 4. پخوانۍ ترتیب د احساس سره مداخله کوي
د خراب متنونو سربیره، اسناد د ډیزاین لخوا خراب کیدی شي. خلک د ښه لیکل شوي موادو لوستلو سره عادی دي. بلاګونه، ټولنیزې شبکې، رسنۍ - ټول مینځپانګه نه یوازې ښکلې، بلکې د لوستلو لپاره اسانه او سترګو ته د خوښې وړ وړاندې کیږي. له همدې امله ، تاسو کولی شئ په اسانۍ سره د هغه چا درد درک کړئ څوک چې د لاندې سکرین شاټ په څیر متن ګوري.
پدې مقاله کې ډیری سکرین شاټونه او مهمې څرګندونې شتون لري چې دوی مرسته نه کوي ، مګر یوازې د لید سره مداخله کوي (تصویر د کلیک کولو وړ دی)
تاسو باید د ډیرو اغیزو سره د اسنادو څخه اوږده مطالعه ونه کړئ، مګر تاسو اړتیا لرئ چې اساسي اصول په پام کې ونیسئ.
ترتیب. د بدن متن عرض، فونټ، اندازه، سرلیکونه، او پیډینګ مشخص کړئ. یو ډیزاینر وګمارئ، او د کار منلو یا پخپله یې ترسره کړئ، د آرټیوم ګوربونوف کتاب "ټایپوګرافي او ترتیب" ولولئ. دا د ترتیب یوازې یو لید وړاندې کوي، مګر دا کافي دی.
تخصیصات. معلوم کړئ چې په متن کې څه ټینګار ته اړتیا لري. عموما دا د انٹرفیس، بټونو، کوډ داخلولو، د ترتیب کولو فایلونو، "مهرباني وکړئ" بلاکونو کې یوه لاره ده. معلوم کړئ چې د دې عناصرو تخصیص به څه وي او په مقرراتو کې یې ثبت کړئ. په یاد ولرئ چې لږ خارج کیږي، ښه. کله چې دوی ډیری وي، متن شور دی. حتی د نرخ نښه هم شور رامینځته کوي که چیرې دوی ډیر ځله وکارول شي.
پردې شاټونه. د ټیم سره موافقه وکړئ چې په کومو قضیو کې سکرین شاټونو ته اړتیا وي. د هر ګام روښانه کولو ته یقینا اړتیا نشته. د سکرین شاټونو لوی شمیر، په شمول. جلا تڼۍ، د مفهوم مداخله، ترتیب خراب کړئ. اندازه وټاکئ، په بیله بیا په سکرین شاټونو کې د ځانګړتیاوو او لاسلیکونو بڼه، او په مقرراتو کې یې ثبت کړئ. په یاد ولرئ چې انځورونه باید تل د هغه څه سره مطابقت ولري چې لیکل شوي او اړونده وي. بیا بیا، که محصول په منظمه توګه تازه شي، نو د هرچا تعقیب به ستونزمن وي.
د متن اوږدوالی. د ډیرو اوږدو مقالو څخه ډډه وکړئ. دوی په برخو وویشئ، او که ممکنه نه وي، د مقالې په پیل کې د لنگر لینکونو سره مینځپانګې اضافه کړئ. د یوې مقالې د لید لنډ کولو لپاره یوه ساده لار دا ده چې تخنیکي توضیحات پټ کړئ چې د لوستونکو د یوې تنګ حلقې لخوا د سپیلر لاندې اړین دي.
شکلونه. په خپلو مقالو کې ډیری بڼې یوځای کړئ: متن، ویډیو او انځورونه. دا به مفکوره ښه کړي.
د ښکلي ترتیب سره د ستونزو پټولو هڅه مه کوئ. په ریښتیا، موږ پخپله هیله درلوده چې "ریپر" به زاړه اسناد خوندي کړي - دا کار ونکړ. په متنونو کې دومره بصری شور او غیر ضروري توضیحات شامل وو چې مقررات او نوې ډیزاین بې ځواکه وو.
د پورتني ډیری برخه به د هغه پلیټ فارم لخوا ټاکل کیږي چې تاسو یې د اسنادو لپاره کاروئ. د مثال په توګه، موږ کنفرنس لرو. زه هم باید له هغه سره اړیکه ونیسم. که علاقه لرئ، زموږ د ویب پراختیا کونکي کیسه ولولئ: .
له کوم ځای څخه ښه کول پیل کړئ او څنګه ژوندي پاتې شئ
که ستاسو اسناد د ISPsystem په څیر پراخ وي او تاسو نه پوهیږئ چیرته یې پیل کړئ، د لویو ستونزو سره پیل کړئ. پیرودونکي په سند نه پوهیږي - متنونه ښه کړئ، مقررات جوړ کړئ، لیکوالان وروزل. اسناد زاړه دي - د داخلي پروسو پاملرنه وکړئ. د خورا مشهور محصولاتو په اړه د خورا مشهور مقالو سره پیل کړئ: د ملاتړ غوښتنه وکړئ ، د سایټ تحلیلونو او د لټون انجنونو کې پوښتنې وګورئ.
راځئ چې سمدلاسه ووایو - دا به اسانه نه وي. او دا امکان نلري چې ژر کار وکړي. پرته لدې چې تاسو یوازې پیل کوئ او سم کار وکړئ. یو شی چې موږ د ډاډ لپاره پوهیږو دا به د وخت په تیریدو سره ښه شي. مګر پروسه به هیڅکله پای ته ونه رسیږي :-).
سرچینه: www.habr.com