Bon pratik yo devlope lojisyèl gratis epi ouvè: Dokimantasyon

Dokimantasyon: Bon pratik yo devlope lojisyèl gratis epi yo louvri

Dokimantasyon: Bon pratik yo devlope lojisyèl gratis epi yo louvri

La dokiman se epi yo ta dwe yon pati fondamantal nan la pwosesis kreyatif ak planifikasyon nan tout aktivite imen, ak plis ankò nan jaden teknolojik la, espesyalman nan zòn nan Devlopman lojisyèl.

El objektif tout dokiman yo li dwe Li anseye twazyèm pati (itilizatè, administratè, antretyen, oswa lòt devlopè), ki moun ki pa anjeneral abitye avèk la pwodwi (kòd, aplikasyon oswa sistèm), ki jan li kreye estrikti li yo, operasyon li yo e menm si li posib, rezon ki fè kreyasyon li yo ak fason li yo nan konsepsyon ak operasyon.

Bon pratik: Dokimantasyon - Entwodiksyon

Anplis de sa, nan ka a espesifik nan Dokiman lojisyèl gratis enpòtan anpil, depi li pèmèt yo konplètman garanti a transfè konesans ak otonòm nesesè pou pwogrè nan satisfezan nan la 4 libète ankouraje pa li, ki se:

  • 0: Libète a nan kouri pwogram nan sepandan ou vle, pou nenpòt ki rezon.
  • 1: Libète pou jwenn ak etidye yon pwogram, epi chanje oswa adapte li pou pwòp benefis ou.
  • 2: Libète pou pataje oswa redistribiye kopi pou simaye menm bagay la tou ak / oswa ede lòt moun.
  • 3: Libète pou distribye kopi vèsyon modifye ou bay twazyèm pati.

Yon bon dokiman fè li posib, Se poutèt sa, ke pwodwi a kreye:

  • Li se itilize kòrèkteman, epi li se pi fasil anseye ak aprann.
  • Fè byen konprann pa moun ki vle modifye li amelyore oswa adapte li.
  • Fè pataje ak resevwa ak plis konfyans, nan mitan tout zanmi potansyèl ak etranje.
  • Fè yon pi bon mas nan mitan piblik la.

Bon pratik: Dokimantasyon - Readme

Bon pratik: Dokimantasyon

Fondamantal

Nan ka Devlopman lojisyèl gratis ak sous louvri, jeneralman, itilizatè prensipal nan dokiman an ki gen rapò ak konsepsyon pwodwi yo, se moun ki se oswa yo pral, la responsab pou antretyen nan menm bagay la. Ak san yo pa bon oswa ki pa gen okenn dokiman, altènatif la sèlman solid se dirèkteman eksplore li, reyalize konprann konsepsyon li yo ak fonksyon.

Pa kreye bon dokiman lè li rive devlope lojisyèl gratis, sous louvri oswa nenpòt lòt kalite lojisyèl, se voye bay benefisyè posib li yo (itilizatè, administratè, antretyen, oswa lòt devlopè) jwenn yon fason nan yon forè san yon kat oswa yon konpa.

Kreye bon dokiman pou chak Lojisyèl gratis, sous louvri li se tou benefisye, depi, byenke dokimante gen yon priEnvestisman an, si li fè kòrèkteman, vo li. Paske, mond lan nan lojisyèl se tout istwa sou kòd eritaj nan pwogram ansyen oswa aktyèl, aplikasyon oswa sistèm, ke se sèlman kèk moun ki azade manyen, paske prèske pèsonn pa konprann. Pwogramasyon konsantre sou kreye kòd epi yo pa dokimante li kòrèkteman ak konplètman. Lè sa a dwe remèd.

Bon pratik sou dokiman nan dosye tèks README

Nan ka Lojisyèl gratis ak sous louvri, Dokiman souvan limite nan dosye tèks, lè li kreye pa moun oswa ti gwoup pwogramè oswa kominote yo. Men, jiskaske kreye yon dokiman ki senp lè l sèvi avèk yon senp tèks dosye README.md (oswa .txt) ou ka genyen ou pi bon oswa bon pratik, konsèy oswa gid itil nan kreyasyon yo pran bay twazyèm pati enfòmasyon ki pi konplè ak detaye ki nesesè sou kreye a.

Pou atik nou an, nou te pran Bon pratik vin ansent ak divilge pa la "Kòd pou Inisyativ Devlopman" nan Bank entè-Ameriken Devlopman, ki nan yon fason rezime di nou ke bon dokiman ki baze sou yon tèks dosye README.md (oswa .txt) Li dwe estriktire jan sa a:

Rekòmande estrikti dosye README

  • Deskripsyon ak kontèks: Seksyon kote ou dwe dekri fonksyonalite yo, kontèks kote li te devlope ak pwoblèm devlopman li te ede rezoud.
  • Gid itilizatè a: Seksyon kote enstriksyon pou itilizatè final la sou kòman yo kòmanse lè l sèvi avèk zouti dijital la ta dwe mansyone.
  • Gid enstalasyon: Seksyon kote enstriksyon yo enstalasyon yo reutilize ak configured zouti dijital la ta dwe mansyone. Seksyon sa a fèt pou devlopè yo.
  • otè Seksyon kote kredi yo dwe bay kolaboratè yo nan zouti an.
  • Lisans pou kòd la zouti: Seksyon kote otorizasyon yo akòde bay twazyèm pati yo itilize ankò zouti dijital la dwe espesifye.
  • Lisans pou dokiman an nan zouti a: Seksyon kote kalite lisans ki genyen nan dokiman ki kreye a dwe mansyone.

Nan sa yo bon pratik, yo menm tou yo rekòmande ajoute nan la README dokiman dosye pou fè li pi konplè, seksyon sa yo:

  • Kijan pou kontribye: Seksyon ki eksplike nouvo devlopè pwosesis pou kontribye nan pwojè yo.
  • Kòd konduit: Seksyon ki eksplike kòd konduit la etabli nòm sosyal yo, règleman yo ak responsablite ke moun yo ak òganizasyon yo dwe swiv lè kominike nan nenpòt fason ak zouti dijital la oswa kominote yo.
  • Badj: Seksyon ki montre badj yo (ti imaj entegre nan README.md) ki presize nan yon fason lizib ak kout eta a nan zouti a.
  • Vèsyon: Seksyon ki endike yon lis vèsyon yo nan zouti dijital la ak fonksyonalite yo ajoute nan chak vèsyon.
  • Remèsiman: Seksyon ki gen rekonesans yo bay lòt moun oswa òganizasyon ki te kontribye nan kèk fason nan pwojè a.

Pou elaji enfòmasyon sa a, sou la Bon pratik nan zafè dokiman pou devlopman nan Gratis lojisyèl, pa la "Kòd pou Inisyativ Devlopman" nan Bank entè-Ameriken Devlopman ou ka klike sou lyen sa a: Dokimantasyon - Gid pou pibliye zouti dijital. Ak nan lòt piblikasyon nou pral eksplore pati a refere li a bon pratik sou la evalyasyon ak lisans nan Lojisyèl gratis epi ouvè tèt yo.

Konklizyon

Konklizyon

Nou espere sa sa a "itil ti pòs" sou «Buenas prácticas» nan jaden an nan «documentación» yo kreye lè devlope «Software libre y abierto», se nan gwo enterè ak sèvis piblik, pou tout la «Comunidad de Software Libre y Código Abierto» ak nan gwo kontribisyon nan difizyon nan ekosistèm la bèl bagay, jigantèsk ak ap grandi nan aplikasyon pou ak pou «GNU/Linux».

Ak pou plis enfòmasyon, pa toujou ezite vizite nenpòt ki Bibliyotèk sou entènèt kòm OpenLibra y jedit li liv (PDFs) sou sijè sa a oswa lòt moun zòn konesans. Pou kounye a, si ou te renmen sa a «publicación», pa sispann pataje li ak lòt moun, nan ou Sit entènèt pi renmen, chanèl, gwoup, oswa kominote yo nan rezo sosyal, de preferans gratis epi yo louvri kòm Mastodon, oswa sekirite ak prive tankou Telegram.

Oswa tou senpleman vizite paj lakay nou nan Soti nan Linux oswa rantre nan Chèn ofisyèl la Telegram ki soti nan FromLinux li ak vote pou sa a oswa lòt piblikasyon enteresan sou «Software Libre», «Código Abierto», «GNU/Linux» ak lòt sijè ki gen rapò ak «Informática y la Computación»ak la «Actualidad tecnológica».


Kontni an nan atik la respekte prensip nou yo nan etik editoryal. Pou rapòte yon erè klike sou isit la.

Se pou premye a fè kòmantè

Kite kòmantè ou

Adrès imèl ou pa pral dwe pibliye. Jaden obligatwa yo make ak *

*

*

  1. Responsab pou done yo: Miguel Ángel Gatón
  2. Objektif done yo: Kontwòl SPAM, jesyon kòmantè.
  3. Lejitimasyon: konsantman ou
  4. Kominikasyon nan done yo: done yo pa pral kominike bay twazyèm pati eksepte pa obligasyon legal.
  5. Done depo: baz done anime pa rezo Occentus (Inyon Ewopeyen)
  6. Dwa: Nenpòt ki lè ou ka limite, refè ak efase enfòmasyon ou yo.