Awọn iṣe to dara lati dagbasoke Software ọfẹ ati ṣii: Iwe-ipamọ

Iwe aṣẹ: Awọn iṣe to dara lati dagbasoke Software ọfẹ ati ṣii

Iwe aṣẹ: Awọn iṣe to dara lati dagbasoke Software ọfẹ ati ṣii

La iwe-aṣẹ jẹ ati pe o yẹ ki o jẹ apakan ipilẹ ti ilana ẹda ati eto ti gbogbo iṣẹ eniyan, ati diẹ sii ni aaye imọ-ẹrọ, paapaa ni agbegbe ti Idagbasoke Software.

El idi ti gbogbo iwe o gbọdọ jẹ Oun kọ awọn ẹgbẹ kẹta (awọn olumulo, awọn alakoso, awọn olutọju, tabi awọn oludagbasoke miiran), ti ko saba mọ awọn ọja (koodu, ohun elo tabi eto), bawo ni o ṣe ṣẹda eto rẹ, iṣẹ rẹ ati paapaa ti o ba ṣeeṣe, idi fun ẹda rẹ ati ọna apẹrẹ ati isẹ rẹ.

Awọn iṣe to dara: Iwe - Ifihan

Siwaju si, ninu ọran kan pato ti Iwe aṣẹ sọfitiwia ọfẹ jẹ pataki, niwon o gba laaye lati ṣe iṣeduro ni kikun awọn gbigbe imo ati ifiagbara pataki fun itẹlọrun itẹlọrun ti awọn 4 ominira igbega nipasẹ rẹ, eyiti o jẹ:

  • 0: Ominira lati ṣiṣẹ eto naa bi o ṣe fẹ, fun eyikeyi idi.
  • 1: Ominira lati ni iraye si ati kawe eto kan, ati yi pada tabi ṣatunṣe rẹ fun anfani tirẹ.
  • 2: Ominira lati pin tabi tun pin awọn ẹda lati tan kanna ati / tabi ṣe iranlọwọ fun awọn miiran.
  • 3: Ominira lati kaakiri awọn ẹda ti awọn ẹya ti a ti yipada si awọn ẹgbẹ kẹta.

Iwe ti o dara jẹ ki o ṣee ṣe, nitorinaa, pe ọja ti a ṣẹda:

  • O ti lo ni deede, ati pe o ni irọrun kọwa ati kọ ẹkọ.
  • Jẹ ki oye ye rẹ daradara nipasẹ awọn ti o fẹ lati yipada lati ṣe ilọsiwaju tabi muṣe rẹ.
  • Ṣe pinpin ati gba pẹlu igboya diẹ sii, laarin gbogbo awọn alamọmọ ati awọn alejo ti o ni agbara.
  • Ni ibi ti o dara julọ laarin gbogbo eniyan.

Awọn iṣe to dara: Iwe-akọọlẹ - Readme

Awọn iṣe to dara: Iwe-ipamọ

Awọn ipilẹ

Ninu ọran ti Idagbasoke ti Sọfitiwia ọfẹ ati Orisun Ṣi i, ni gbogbogbo, awọn olumulo akọkọ ti iwe-ipamọ naa ti o ni ibatan si apẹrẹ ọja, ni awọn ti o wa tabi yoo jẹ, awọn lodidi fun itọju ti kanna. Ati laisi didara tabi ko si awọn iwe aṣẹ, yiyan ṣiṣeeṣe nikan ni lati ṣawari rẹ taara, lati ṣaṣeyọri loye apẹrẹ ati iṣẹ rẹ.

Ko ṣiṣẹda iwe ti o dara nigbati o ba de dagbasoke Software ọfẹ, Ṣii Orisun tabi eyikeyi iru sọfitiwia miiran, ni lati firanṣẹ si awọn olugba ti o ṣee ṣe (awọn olumulo, awọn alakoso, awọn olutọju, tabi awọn oludasile miiran) lati wa ọna nipasẹ igbo kan laisi maapu tabi kọmpasi kan.

Ṣẹda iwe ti o dara fun ọkọọkan Software ọfẹ, Orisun Ṣi i o tun jẹ anfani, niwon, botilẹjẹpe iwe-ipamọ ni iye owo kanIdoko-owo, ti o ba ṣe ni deede, o tọ si. Nitori, agbaye ti software ti kun fun awọn itan nipa julọ ​​koodu ti atijọ tabi awọn eto lọwọlọwọ, awọn ohun elo tabi awọn ọna ṣiṣe, ti eniyan diẹ nikan ni agbodo lati fi ọwọ kan, nitori o fẹrẹ fẹrẹ jẹ pe ẹnikan loye. Awọn onise-ọrọ fojusi lori ṣiṣẹda koodu ati kii ṣe akọsilẹ ni deede ati ni pipe. Ati pe eyi gbọdọ wa ni atunṣe.

Awọn iṣe to dara lori iwe-ipamọ ni awọn faili ọrọ README

Ninu ọran ti Free Software ati Open Source, iwe aṣẹ ni igbagbogbo ni ihamọ si awọn faili ọrọ, nigbati o ṣẹda nipasẹ awọn ẹni-kọọkan tabi awọn ẹgbẹ kekere ti awọn olutọpa tabi awọn agbegbe. Ṣugbọn, titi ti o fi ṣẹda iwe ti o rọrun nipa lilo rọrun faili ọrọ README.md (tabi .txt) o le ni rẹ awọn iṣẹ ti o dara julọ tabi ti o dara, awọn imọran tabi itọsọna to wulo ti ẹda lati mu si awọn ẹgbẹ kẹta pipe ati alaye ti o ṣe pataki julọ ti o ṣẹda nipa ti ṣẹda.

Fun nkan wa, a ti mu Awọn iṣẹ rere loyun ati ṣafihan nipasẹ awọn "Koodu fun Idagbasoke Idagbasoke" del Banki Idagbasoke Amẹrika-Amẹrika, eyiti o ṣe akopọ sọ fun wa pe awọn iwe ti o dara ti o da lori a faili ọrọ README.md (tabi .txt) O gbọdọ wa ni ipilẹ bi atẹle:

Iṣeduro ọna kika faili README

  • Apejuwe ati ipo: Abala nibiti o gbọdọ ṣapejuwe awọn iṣẹ ṣiṣe, ipo ti o ti dagbasoke ati awọn iṣoro idagbasoke ti o ṣe iranlọwọ yanju.
  • Itọsọna Olumulo: Abala nibiti awọn itọnisọna si olumulo ipari lori bii o ṣe bẹrẹ lilo irinṣẹ oni-nọmba yẹ ki o mẹnuba.
  • Itọsọna fifi sori ẹrọ: Abala nibiti awọn ilana fifi sori ẹrọ lati tun lo ati tunto irinṣẹ oni-nọmba yẹ ki o mẹnuba. Apakan yii ni a pinnu fun awọn oludasile.
  • Awọn onkọwe Apakan nibiti a gbọdọ fi awọn kirediti fun awọn alabaṣiṣẹpọ ti irinṣẹ.
  • Iwe-aṣẹ fun koodu irinṣẹ: Abala nibiti awọn igbanilaaye ti a fun si awọn ẹgbẹ kẹta lati tun lo irinṣẹ oni-nọmba gbọdọ wa ni pàtó.
  • Iwe-aṣẹ fun iwe aṣẹ irinṣẹ: Abala nibiti iru iwe-aṣẹ ti o wa ninu iwe ti a ṣẹda gbọdọ wa ni mẹnuba.

Ni wọnyi awọn iṣẹ rere, wọn tun ṣe iṣeduro fifi si awọn README iwe aṣẹ faili lati jẹ ki o pe ni pipe, awọn abala wọnyi:

  • Bii o ṣe le ṣe alabapin: Abala ti o ṣalaye fun awọn oludasile tuntun ilana lati ṣe alabapin si awọn iṣẹ akanṣe.
  • Kodu fun iwa wiwu: Abala ti o ṣalaye koodu ihuwasi ṣe agbekalẹ awọn ilana awujọ, awọn ofin ati awọn ojuse ti awọn eniyan kọọkan ati awọn ajo gbọdọ tẹle nigbati wọn ba n ṣepọ ni eyikeyi ọna pẹlu ohun elo oni-nọmba tabi agbegbe wọn.
  • Awọn baagi: Abala ti n ṣe afihan awọn ami (awọn aworan kekere ti a fi sinu README.md) eyiti o ṣalaye ni ọna kika ati ṣoki ipo ti ohun elo naa.
  • Ẹya: Abala ti o tọka atokọ ti awọn ẹya ti irinṣẹ oni-nọmba ati awọn iṣẹ ṣiṣe ti a ṣafikun si ẹya kọọkan.
  • Awọn ifọwọsi: Abala ti o ni awọn ijẹrisi si awọn eniyan miiran tabi awọn ajo ti o ti ṣe iranlọwọ ni ọna kan si iṣẹ akanṣe.

Lati faagun alaye yii, lori awọn Awọn iṣẹ rere ni awọn ọrọ ti Iwe akosilẹ fun idagbasoke ti Software Alailowaya, nipase "Koodu fun Idagbasoke Idagbasoke" del Banki Idagbasoke Amẹrika-Amẹrika o le tẹ lori ọna asopọ atẹle: Iwe - Itọsọna fun titẹ awọn irinṣẹ oni-nọmba. Ati ninu awọn atẹjade miiran a yoo ṣawari apakan ti o tọka si awọn iṣẹ rere lori awọn imọ ati asẹ del Free ati Open Software ara wọn.

Ipari

Ipari

A nireti pe esta "wulo kekere post" nipa «Buenas prácticas» ni aaye ti «documentación» lati ṣẹda nigbati o ndagbasoke «Software libre y abierto», jẹ anfani nla ati iwulo, fun gbogbo rẹ «Comunidad de Software Libre y Código Abierto» ati ti ilowosi nla si itankale ti iyanu, titobi ati ilolupo eda abemi aye ti awọn ohun elo ti ati fun «GNU/Linux».

Ati fun alaye diẹ sii, ma ṣe ṣiyemeji nigbagbogbo lati ṣabẹwo si eyikeyi Online ìkàwé bi OpenLibra y Idajọ lati ka awọn iwe (PDFs) lori koko yii tabi awọn miiran awọn agbegbe imọ. Fun bayi, ti o ba fẹran eyi «publicación», maṣe da pinpin rẹ pẹlu awọn omiiran, ninu rẹ Awọn oju opo wẹẹbu ayanfẹ, awọn ikanni, awọn ẹgbẹ, tabi awọn agbegbe ti awọn nẹtiwọọki awujọ, pelu ọfẹ ati ṣii bi Mastodon, tabi ni aabo ati ni ikọkọ bi Telegram.

Tabi ṣe abẹwo si oju-iwe ile wa ni LatiLaini tabi darapọ mọ Ikanni osise Telegram lati FromLinux lati ka ati dibo fun eyi tabi awọn atẹjade ti o nifẹ lori «Software Libre», «Código Abierto», «GNU/Linux» ati awọn akọle miiran ti o ni ibatan si «Informática y la Computación»ati awọn «Actualidad tecnológica».


Awọn akoonu ti nkan naa faramọ awọn ilana wa ti awọn ilana olootu. Lati jabo aṣiṣe kan tẹ nibi.

Jẹ akọkọ lati sọ ọrọ

Fi ọrọ rẹ silẹ

Adirẹsi imeeli rẹ yoo ko le ṣe atejade. O beere aaye ti wa ni samisi pẹlu *

*

*

  1. Lodidi fun data naa: Miguel Ángel Gatón
  2. Idi ti data naa: SPAM Iṣakoso, iṣakoso ọrọ asọye.
  3. Ofin: Iyọọda rẹ
  4. Ibaraẹnisọrọ data: Awọn data kii yoo ni ifọrọhan si awọn ẹgbẹ kẹta ayafi nipasẹ ọranyan ofin.
  5. Ibi ipamọ data: Alaye data ti o gbalejo nipasẹ Awọn nẹtiwọọki Occentus (EU)
  6. Awọn ẹtọ: Ni eyikeyi akoko o le ni opin, gba pada ki o paarẹ alaye rẹ.