Dukumeenti software waa maqaallo kooban. Laakiin xataa iyagu way ku waali karaan. Marka hore, waxaad waqti dheer ku qaadataa raadinta tilmaamaha lagama maarmaanka ah. Markaa waxaad fahmaysaa qoraalka daahsoon. Waxaad samaysaa sida qoran, laakiin dhibka lama xalin. Waxaad raadisaa maqaal kale, waad naxsanaysaa...sacad kadib wax walba waad ka quusatay oo iska tagtaa. Tani waa sida dukumeentiyada xun u shaqeeyaan. Maxaa ka dhigaya sidan oo kale iyo sida loo hagaajiyo - akhri hoostiisa.
Nuqullo badan baa ku jiray dukumeentiyadii hore. Waxa aanu dib u shaqaynaynay ku dhawaad hal sano hadda si xaalada kor lagu sheegay aanay saamayn ugu yeelan macaamiisheena. Fiiri, и .
Dhibaatada 1: Ma cadda, maqaallo si liidata loo qoray
Haddii dukumeentiga aan la fahmi karin, maxay tahay ujeeddada laga leeyahay? Laakin ma jiro qof si ula kac ah u qoray maqaallo aan la fahmi karin. Waxay dhacaan marka uu qoraagu ka fikirin dhagaystayaasha iyo ujeedada, biyo ku shubo oo aanu ka hubin qoraalka khaladaadka.
- Maqalka. Kahor intaadan qorin maqaal, waxaad u baahan tahay inaad ka fikirto heerka diyaarinta akhristaha. Waa macquul in maqaalka bilowga ah waa inaadan ka boodin tallaabooyinka aasaasiga ah oo aad ka tagto shuruudaha farsamada iyada oo aan sharraxaad lahayn, laakiin maqaal ku saabsan muuqaal naadir ah oo kaliya oo xirfadlayaasha u baahan, waa inaad sharaxdaa macnaha ereyga PHP.
- Goolka. Hal shay oo kale oo aad horay uga sii fikirto. Qoraagu waa in uu dejiyaa yool cad, go’aaminaaya saamaynta faa’iidada leh ee maqaalku leeyahay, oo uu go’aansadaa waxa uu samayn doono akhristuhu marka uu akhriyo. Haddii taas la waayo, waxaad ku dambayn doontaa sharaxaadda dartiis.
- Biyaha iyo cayayaanka. Waxaa jira xog badan oo aan loo baahnayn iyo xafiisyo, khaladaad iyo khaladaad ayaa farageliya aragtida. Xitaa haddii akhristuhu aanu naxwaha naxwaha ahayn, taxadar la'aanta qoraalka ayaa damin karta.
Tixgeli talooyinka kor ku xusan, maqaaladuna waxay noqon doonaan kuwo cad - dammaanad leh. Si aad uga sii fiicnaato, isticmaal annaga .
Dhibaatada 2. Maqaallada kama jawaabaan su'aalaha oo dhan
Way xun tahay marka dukumeentigu aanu la socon horumarka, ka jawaabin su'aalaha dhabta ah, iyo khaladaadka ku jira aan la saxin sanado. Kuwani maaha dhibaatooyin badan oo ka mid ah qoraaga, laakiin waa habaynta hababka shirkadda dhexdeeda.
Dukumeentiyadu kuma socdaan horumarka
Muuqaalka ayaa horeyba loo sii daayay, qorshayaasha suuq-geynta si ay u daboosho, ka dibna waxay soo baxday in maqaalka cusub ama tarjumaada aan weli ku jirin dukumeentiyada. Waxaan xitaa ku qasbanahay inaan dib u dhigno sii-deynta tan awgeed. Waxaad waydiisan kartaa qof walba inuu u dhiibo hawlaha qorayaasha farsamada waqtiga loogu talagalay inta aad rabto, laakiin ma shaqeyn doonto. Haddii habka uusan ahayn mid iswada, xaaladdu way soo noqnoqonaysaa.
Waxaan ku samaynay isbedel YouTrack. Hawsha qorista maqaal ku saabsan sifo cusub waxay ku dhacdaa qoraaga farsamada isla markaaba marka muuqaalka la bilaabo in la tijaabiyo. Ka dib suuqgeyntu waxay wax ka barataa si loogu diyaariyo dalacsiinta. Ogeysiisyadu sidoo kale waxay u yimaadaan Mattermost shirkadda, marka si fudud ma aha wax aan macquul ahayn in la seego wararka horumariyeyaasha.
Dukumeentiyadu kama tarjumayso codsiyada isticmaalaha
Waxaan u barannay inaan u shaqeyno sidan: muuqaal ayaa soo baxay, waan ka hadalnay. Waxaan ku sharaxnay sida loo shido, loo damiyo, oo loo sameeyo hagaajin wanaagsan. Laakiin maxaa dhacaya haddii macmiilku u isticmaalo software-kayaga qaab aanan filayn? Mise waxay leedahay khaladaad aynaan ka fikirin?
Si loo hubiyo in dukumeentigu u dhammaystiran yahay intii suurtagal ah, waxaan kugula talineynaa in la falanqeeyo codsiyada taageerada, su'aalaha ku saabsan golayaasha mawduucyada, iyo weydiimaha matoorada raadinta. Mawduucyada ugu caansan waxaa loo wareejin doonaa qorayaasha farsamada si ay u kabaan maqaallada jira ama u qoraan kuwa cusub.
Dukumentiyada lama hagaajin
Way adagtahay in si sax ah isla markiiba loo sameeyo; wali waxaa jiri doona khaladaad. Waxaad rajayn kartaa jawaab celin macaamiisha, laakiin uma badna inay soo sheegaan qoraal kasta, khalad, aan la fahmi karin ama aan sal lahayn. Marka lagu daro macaamiisha, shaqaaluhu waxay akhriyaan dukumentiyada, taas oo macnaheedu yahay inay arkaan khaladaad isku mid ah. Tani waa la isticmaali karaa! Kaliya waxaad u baahan tahay inaad abuurto shuruudo ay ku fududaan doonto inaad ka warbixiso dhibaato.
Waxaan ku haynaa koox ku taal portal-ka gudaha halkaas oo shaqaaluhu kaga tagaan faallooyinka, talooyinka iyo fikradaha dukumeentiga. Taageeradu ma waxay u baahan tahay maqaal, laakiin ma jiraan? Tijaabahu ma ogaaday khaladka? Lammaanaha miyuu ka cawday maareeyayaasha horumarinta khaladaadka? Dhammaan kooxdan! Qorayaasha farsamada ayaa isla markaaba hagaajiya waxyaalaha qaarkood, waxay u gudbiyaan waxyaalaha qaarkood YouTrack, qaarna waxay siiyaan wakhti ay kaga fikiraan. Si looga hortago in mawduuca hoos u dhaco, mar mar waxaan ku xasuusineynaa jiritaanka kooxda iyo muhiimada ay leedahay jawaab celinta.
Dhibaatada 3. Waxay qaadataa wakhti dheer in la helo maqaal sax ah.
Maqaal aan la heli karin ma roona maqaal aan la heli karin. Hal-ku-dhegga dukumeenti wanaagsan waa inuu noqdaa "Si sahlan in la baadho, si sahlan loo helo." Sidee lagu gaari karaa tan?
Abaabulka qaabka oo go'aami mabda'a doorashada mawduucyada. Qaabdhismeedku waa inuu noqdaa mid hufan intii suurtagal ah si aanu akhristuhu u malayn, "Xaggee ayaan ka heli karaa maqaalkan?" Si loo soo koobo, waxaa jira laba hab: laga bilaabo interface ka iyo hawlaha.
- Laga soo bilaabo interface-ka. Nuxurku wuxuu nuqul ka dhigayaa qaybaha guddida. Tani waxay ahayd kiiska dukumeentigii hore ee ISPsystem.
- Laga soo bilaabo hawlaha. Magacyada maqaallada iyo qaybaha waxay ka tarjumayaan hawlaha isticmaalayaasha; Cinwaanadu had iyo jeer waxay ka kooban yihiin fal iyo jawaabo su'aasha "sida loo sameeyo". Hadda waxaan u dhaqaaqeynaa qaabkan.
Hab kasta oo aad doorato, hubi in mawduuca uu khuseeyo waxa isticmaalayaashu raadinayaan iyo in lagu daboolay hab si gaar ah uga hadlaya su'aasha isticmaalaha.
Deji goob goob dhexe. Adduunka ku habboon, raadinta waa inay shaqeysaa xitaa marka aad si qaldan u qorto ama aad luqadda qalad ku gasho. Raadintayada Confluence ilaa hadda kama farxin karno tan. Haddii aad haysato badeecooyin badan oo dukumeentigu yahay mid guud, ku habboon raadinta bogga isticmaalaha uu ku jiro. Xaaladeena, raadinta bogga ugu muhiimsan waxay u shaqeysaa dhammaan alaabooyinka, iyo haddii aad horeyba ugu jirtay qayb gaar ah, ka dibna kaliya maqaallada ku jira.
Ku dar nuxurka iyo roodhida. Way fiican tahay marka bog kastaa leeyahay menu iyo rooti - dariiqa isticmaalaha ee bogga hadda oo awood u leh inuu ku soo laabto heer kasta. Dukumeentigii hore ee ISPsystem, waa inaad ka baxdaa maqaalka si aad u hesho waxa ku jira. Waxay ahayd dhib, sidaas darteed waxaan ku hagaajinnay midka cusub.
Geli iskuxirayaasha alaabta. Haddii dadku u yimaadaan inay ku taageeraan marar badan isla su'aal isku mid ah, waxay macno samaynaysaa in lagu daro tilmaam xalkeeda interface-ka. Haddii aad hayso xog ama aragti ku saabsan marka isticmaaluhu la kulmaayo dhibaato, waxaad sidoo kale ku ogeysiin kartaa liiska boostada. U tus welwel oo ka saar culayska taageerada.
Dhinaca midig ee daaqada soo-gudbintu waa isku xirka maqaal ku saabsan dejinta DNSSEC ee qaybta maamulka domain ee ISPmanager
Samee tixraacyo isdhaafsan gudaha dukumeentiyada. Maqaallada isku xidhan waa in ay noqdaan kuwo "isku xidhan". Haddii maqaaladu ay yihiin kuwo isdaba-joog ah, hubso inaad ku darto fallaadho hore iyo gadaal dambe dhammaadka qoraal kasta.
Waxay u badan tahay, qofku marka hore wuxuu aadi doonaa raadinta jawaabta su'aashiisa adiga maaha, laakiin inuu raadiyo mashiinka raadinta. Waa ceeb haddii aysan jirin wax xiriir ah dukumentiyada halkaas sababo farsamo awgeed. Markaa ka taxadar hagaajinta mashiinka raadinta.
Dhibaatada 4. Qaabaynta duugowday waxay faragelisaa aragtida
Marka lagu daro qoraallada xun, dukumeentiyada waxaa lagu kharibi karaa naqshadeynta. Dadku waxay caadeysteen inay akhriyaan agab si wanaagsan loo qoray. Blogs, shabakadaha bulshada, warbaahinta - dhammaan waxyaabaha la soo bandhigay ma aha oo kaliya qurux badan, laakiin sidoo kale waa sahlan tahay in la akhriyo oo lagu raaxaysto indhaha. Sidaa darteed, waxaad si fudud u fahmi kartaa xanuunka qofka arka qoraalka sida sawirka hoose.
Waxaa jira sawirro badan oo shaashado ah oo maqaalkan ku jira oo ayan ku caawinaynin, laakiin kaliya waxay farageliyaan aragtida (sawirka waa la gujin karaa)
Waa inaadan akhrin dheer ka samayn dukumeentiyada saameyno badan leh, laakiin waxaad u baahan tahay inaad tixgeliso xeerarka aasaasiga ah.
Qaabka. Go'aami ballaca qoraalka jirka, farta, cabbirka, ciwaannada, iyo suufka. Kirayso naqshadeeye, iyo si aad u aqbasho shaqada ama aad naftaada u qabato, akhri buuga Artyom Gorbunov ee "Qoritaanka iyo Qaabka." Waxay soo bandhigaysaa hal aragti oo kaliya ee qaabka, laakiin waa ku filan tahay.
Qoondaynta. Go'aanso waxa u baahan in xoogga la saaro qoraalka. Caadi ahaan kani waa dariiqa dhex dhexaadiyaha, badhamada, koodka gelinta, faylasha qaabaynta, "Fadlan ogow" blocks. Go'aanso waxa loo qaybinayo walxahan oo ku qor xeerarka. Maskaxda ku hay in dheecaanku yaraado, ay ka sii fiican tahay. Marka ay badan yihiin, qoraalku waa buuq badan yahay. Xitaa calaamadaha xigashada waxay abuuraan buuq haddii marar badan la isticmaalo.
Screenshots. Kala heshiis kooxda xaaladaha loo baahan yahay shaashadaha. Dhab ahaantii ma jirto baahi loo qabo in la muujiyo tallaabo kasta. Tiro badan oo shaashado ah, oo ay ku jiraan. badhamada kala soocida, farageliyaan aragtida, kharribaan qaabka. Go'aami cabbirka, iyo sidoo kale qaabka iftiiminta iyo saxeexyada shaashadda, oo ku duub xeerarka. Xasuusnoow in sawiradu ay had iyo jeer u dhigmaan waxa qoran oo ay noqdaan kuwo khuseeya. Mar labaad, haddii alaabta si joogto ah loo cusboonaysiiyo, way adkaan doontaa in qof walba lala socdo.
Dhererka qoraalka. Ka fogow maqaallada aadka u dheer. U kala qaybi qaybo, oo hadday tani suurtogal noqon weydo, ku dar nuxur leh xiriiriyeyaasha barroosinka bilowga maqaalka. Habka fudud ee maqaalka looga dhigi karo muuqaal gaaban waa in la qariyo tafaasiisha farsamo ee ay u baahan yihiin goobaabin cidhiidhi ah oo akhristayaasha ah oo hoos yimaada qaswade.
Qaababka. Ku dar qaabab badan oo maqaalladaada ah: qoraal, muuqaal iyo sawirro. Tani waxay hagaajin doontaa aragtida.
Ha isku dayin inaad ku daboosho dhibaatooyinka qaabka quruxda badan. Daacadnimo, annagu nafteenna waxaan rajaynaynay in "duubaha" uu badbaadin doono dukumeenti hore - ma aysan shaqeyn. Qoraalladu waxay ka koobnaayeen buuq badan oo muuqaal ah iyo faahfaahin aan loo baahnayn in xeerarka iyo naqshadeynta cusub ay ahaayeen kuwo aan awood lahayn.
Inta badan kuwa sare waxaa go'aamin doona goobta aad u isticmaaleyso dukumentiyada. Tusaale ahaan, waxaan leenahay Confluence. Waxa aan ku khasbanaaday in aan isagana la tashado. Haddii aad xiisaynayso, akhri sheekada horumariyaha shabakadayada: .
Halkee laga bilaabo hagaajinta iyo sida loo noolaado
Haddii dukumeentigu u baaxad weyn yahay sida ISPsystem's oo aanad garanayn meel aad ka bilowdo, ka bilow dhibaatooyinka ugu waaweyn. Macaamiishu ma fahmaan dukumeentiga - hagaajinta qoraallada, samaynta xeerar, tababar qorayaasha. Dukumeentigu waa dhacay - daryeesho hababka gudaha. Ka bilow maqaallada ugu caansan ee ku saabsan badeecadaha ugu caansan: taageero weydiiso, fiiri falanqaynta goobta iyo weydiimaha matoorada raadinta.
Aynu isla markiiba nidhaahno - ma fududaan doonto. Oo uma badna inay si degdeg ah u shaqeyso sidoo kale. Ilaa aad hadda bilaabayso oo aad samayso waxa saxda ah isla markaaba. Hal shay oo aan hubno ayaa ah in ay soo fiicnaan doonto waqti ka dib. Laakiin geeddi-socodku weligiis ma dhammaan doono :-).
Source: www.habr.com