Dhaqan wanaagsan oo lagu horumariyo Software bilaash ah oo furan: Dukumiinti

La dukumeentiyo waa waana inuu ahaadaa qayb aasaasi ah habka abuurka iyo qorsheynta dhammaan howlaha bini'aadamka, iyo inbadan oo ku saabsan cilmiga farsamada, gaar ahaan aagga Horumarinta barnaamijka.

El ujeeddada dukumiintiyada oo dhan waa inuu asaga yahay baro kooxaha saddexaad (adeegsadayaasha, maamuleyaasha, dayactirayaasha, ama horumariyeyaasha kale), oo aan inta badan aqoon u lahayn sheyga (lambar, codsi ama nidaam), sidee loo abuuray qaab dhismeedkeeda, hawlgalkeeda iyo xitaa haddii ay suurtagal tahay, sababta loo abuuray iyo qaabkeeda loo qaabeeyey iyo loo shaqeeyay.

Intaas waxaa sii dheer, kiiska gaarka ah ee Dukumiintiyada softiweer ee bilaashka ahi waa muhiim, maadaama ay u oggolaaneyso inay si buuxda u damaanad qaado wareejinta aqoonta iyo awoodsiinta lagama maarmaanka u ah qancinta qanacsanaanta ee 4 xorriyadood waxaa kor u qaaday, kuwaas oo ah:

• 0: Xorriyadda aad ku maamuli karto barnaamijka sidaad doonto, ujeeddo kasta ha noqotee.
• 1: Xorriyadda helitaanka iyo barashada barnaamijka, oo u beddelo ama u waafajiyo dantaada.
• 2: Xorriyadda in la wadaago ama dib loo qaybiyo nuqulada si loo faafiyo isla iyo / ama loo caawiyo dadka kale.
• 3: Xorriyadda si loogu qaybiyo nuqulada nuquladaada wax laga beddelay qaybaha saddexaad.

Dukumiinti wanaagsan ayaa suurtagal ka dhigaya, sidaas darteed, in badeecada la abuuray:

• Si sax ah ayaa loo istcimaalaa, waana mid si fudud loo barto oo loo barto.
• Si fiican ay u fahmeen kuwa doonaya inay wax ka beddelaan si ay u hagaajiyaan ama ula qabsadaan.
• In lala wadaago oo lagugu helo kalsooni dheeri ah, dhammaan dadka aqoonta leh iyo shisheeyaha.
• Meel wanaagsan ka hel dadweynaha dhexdiisa.

Dhaqan wanaagsan: Dukumiinti

Aasaasiga

Marka laga hadlayo Horumarinta Barnaamijka Bilaashka ah iyo Ilaha Furan, guud ahaan, isticmaalayaasha ugu muhiimsan ee dukumiintiyada marka loo eego qaabeynta wax soo saarka, waa kuwa jira ama jiri doona, the mas'uul ka ah dayactirka isku mid ah. Iyo iyada oo aan la helin dukumiinti wanaagsan ama aan lahayn, waxa kaliya ee lagu heli karo ayaa ah in si toos ah loo baaro, si loo gaaro fahmaan naqshadeeda iyo shaqadeeda.

Aan la abuurin dukumentiyo wanaagsan markay tahay horumariyo Software Bilaash ah, Isha Furan ama nooc kale oo softiweer ah, waa in loo diro dadka ay suurtogalka tahay in ay helaan (isticmaaleyaasha, maamuleyaasha, dayactirayaasha, ama horumariyeyaasha kale) si loo helo waddo loo maro kaymaha oo aan lahayn khariidad iyo jiheeye.

Abuur dukumiinti wanaagsan midkasta Software Bilaash ah, Isha Furan sidoo kale waa faa'iido, tan iyo, inkasta oo Diiwaangelintu waxay leedahay kharashMaalgashiga, haddii si sax ah loo sameeyo, waa u qalantaa. Sababtoo ah, adduunyada Software waxaa ka buuxa sheekooyin ku saabsan xeerarka dhaxalka barnaamijyadii hore ama kuwa hadda jira, barnaamijyada ama nidaamyada, ee dad yar uun ku dhiirran inay taabtaan, maxaa yeelay ku dhowaad cidna ma fahamto. Barnaamijyayaashu waxay diiradda saaraan sameynta koodh oo si sax ah oo buuxda uma diiwaangeliyaan. Tanina waa in la saxaa.

Dhaqan wanaagsan oo ku saabsan dukumintiyada ku jira README faylasha qoraalka

Marka laga hadlayo Software bilaash ah iyo ilo furan, dukumiintiyada badanaa waxaa lagu xadiday faylalka qoraalka, markii ay abuureen shaqsiyaad ama kooxo yar oo barnaamij ama barnaamijyo bulsho. Laakiin, xitaa abuurista dukumiinti fudud iyadoo la adeegsanayo fudud faylka qoraalka README.md (ama .txt) waad heli kartaa dhaqanka ugu fiican ama wanaagsan, tilmaamaha ama tilmaamaha waxtarka leh ee abuurista si loogu gudbiyo dhinacyada saddexaad macluumaadka ugu dhammaystiran uguna faahfaahsan ee lagama maarmaanka u ah abuurista.

Maqaalkeenna, waxaan u soo qaadnay Dhaqannada wanaagsan uuraysatay oo shaaca ka qaaday "Xeerka Hindisaha Horumarinta" del Bangiga Horumarinta Maraykanka, taasoo marka la soo koobo noo sheegaysa in dukumiintiyada wanaagsan ee ku saleysan a faylka qoraalka README.md (ama .txt) Waa in loo qaabeeyaa sida soo socota:

Qaabdhismeedka feylka README

• Sharaxaadda iyo macnaha guud: Qeybta ay tahay inaad sharraxdo sida ay u shaqeyneyso, macnaha guud ee halka laga sameeyay iyo dhibaatooyinka horumarineed ee ay ka caawisay xalinta.
• Tilmaamaha Isticmaalaha: Qaybta tilmaamaha la siinayo isticmaalaha ugu dambeeya ee ku saabsan sida loo bilaabayo isticmaalka aaladda dhijitaalka ah.
• Tilmaamaha rakibida: Qaybta ay tahay in lagu xuso tilmaamaha rakibida si dib loogu isticmaalo loona habeeyo aaladda dhijitaalka ah. Qaybtani waxaa loogu talagalay horumariyeyaasha.
• Qorayaasha Qaybta ay tahay in dhibco lagu siiyo wada-hawlgalayaasha aaladda.
• Shatiga lambarka qalabka: Qaybta halka rukhsadaha la siiyay dhinac saddexaad si ay dib ugu adeegsadaan qalabka dhijitaalka ah waa in lagu qeexaa.
• Ruqsadda dukumiintiyada qalabka: Qaybta ay tahay in lagu xuso nooca liisanka ku jira dukumintiyada la abuuray.

Kuwani kuwan dhaqamada wanaagsan, waxay kaloo ku talinayaan in lagu daro README dukumiintiyada feylka si aad uga dhigto mid dhammaystiran, qaybaha soo socda:

• Sida wax loogu darsado: Qaybta oo sharraxaysa horumariyeyaasha cusub hannaanka ay ugu kordhinayso mashaariicda.
• Xeerka anshaxa: Qaybta sharraxaysa xeerka anshaxa ayaa dejisa xeerarka bulsheed, xeerarka iyo masuuliyadaha shakhsiyaadka iyo ururradu ay tahay inay raacaan markay si uun ula falgalayaan aaladda dijital ah ama bulshadooda.
• Calaamadaha: Qaybta muujineysa calaamadaha (sawirro yaryar oo ku lifaaqan README.md) oo ku qeexaya hab la aqrin karo oo kooban oo ah xaaladda aaladda.
• Nooca: Qeybta tilmaameysa liiska noocyada qalabka dhijitaalka ah iyo howlaha lagu daro nooc kasta.
• Mahadnaq: Qeybta ay ku jirto aqoonsiga dadka kale ama hay'adaha si uun uga qayb qaatay mashruuca.

Si loo ballaariyo macluumaadkan, Dhaqannada wanaagsan arrimaha Dukumentiyada horumarka Software Free, by "Xeerka Hindisaha Horumarinta" del Bangiga Horumarinta Maraykanka waxaad riixi kartaa xiriirka soo socda: Dukumeentiga - Tilmaamaha daabacaadda aaladaha dijitaalka ah. Qoraallada kalena waxaan ku baari doonnaa qeybta tixraacaya dhaqamada wanaagsan on qiimeynta iyo shati siinta del Free iyo Software furan naftooda.

Gabagabo

Waxaan rajeyneynaa taas waa "waxtar yar post" ku saabsan «Buenas prácticas» berrinkii «documentación» in la abuuro marka la horumarinayo «Software libre y abierto», noqo mid dan weyn iyo dan u leh, dhammaan «Comunidad de Software Libre y Código Abierto» iyo wax ku biirinta weyn ee baahinta nidaamka deegaanka ee cajiibka ah, weyn iyo koraya ee codsiyada iyo wixii loogu talagalay «GNU/Linux».

Iyo wixii macluumaad dheeri ah, ha ka waaban inaad booqato midkoodna Maktabadda internetka sida OpenLibra y JEDIT in la akhriyo buugaag (PDF) mowduucan ama kuwo kale meelaha aqoonta. Hada, hadaad jeceshahay tan «publicación», ha joojin inaad la wadaagto kuwa kale, adiga Websaydhada aad jeceshahay, kanaallada, kooxaha, ama bulshooyinka ee shabakadaha bulshada, doorbidayaa bilaash oo u furan sida Mastodon, ama amaan ah oo gaar loo leeyahay telegraam.

Ama si fudud u soo booqo boggayaga hoyga at DesdeLinux ama ku biir Channel-ka rasmiga ah Telegram ka DesdeLinux in loo akhriyo loona codeeyo tan ama daabacado kale oo xiiso leh «Software Libre», «Código Abierto», «GNU/Linux» iyo mowduucyo kale oo la xiriira «Informática y la Computación», iyo «Actualidad tecnológica».