Добре праксе за развој слободног и отвореног софтвера: Документација

Документација: Добра пракса за развој слободног и отвореног софтвера

Документација: Добра пракса за развој слободног и отвореног софтвера

La документација јесте и треба да буде основни део креативни процес и планирање свих људских активности, а више на технолошком пољу, посебно на подручју Развој софтвера.

El сврха целокупне документације то мора бити Он подучавати треће стране (кориснике, администраторе, одржаваче или друге програмере), који обично нису упознати са производ (код, апликација или систем), како је створен његова структура, његово деловање па чак и ако је могуће, разлог његовог настанка и начин дизајнирања и рада.

Добре праксе: Документација - Увод

Даље, у конкретном случају Документација о бесплатном софтверу је од виталног значаја, јер омогућава потпуно гарантовање пренос знања и оснаживање неопходне за задовољавајуће испуњење 4 слободе које промовише, а то су:

  • 0: Слобода покретања програма по жељи у било коју сврху.
  • 1: Слобода приступа и проучавања програма, као и његова промена или прилагођавање у вашу корист.
  • 2: Слобода дељења или поновне дистрибуције копија ради ширења истих и / или помоћи другима.
  • 3: Слобода дистрибуције копија ваших измењених верзија трећим лицима.

Добра документација омогућава, према томе, да створени производ:

  • Користи се правилно, а лакше се учи и учи.
  • Они који желе да га модификују како би га побољшали или прилагодили, добро разумеју.
  • Будите подељени и примљени са више самопоуздања, међу свим потенцијалним познаницима и странцима.
  • Имајте бољу масу у јавности.

Добре праксе: Документација - Реадме

Добре праксе: Документација

Основе

У случају Развој слободног софтвера и отвореног кода, обично, главни корисници документације повезани са дизајном производа, јесу ли они који јесу или ће бити одговоран за одржавање истог. И без добре документације или без ње, једина одржива алтернатива је директно истраживање, постизање разуме његов дизајн и функцију.

Не стварање добре документације када је реч о томе развити слободни софтвер, отворени извор или било коју другу врсту софтвера, је слање могућим примаоцима (корисници, администратори, одржавачи или други програмери) пронаћи пут кроз џунглу без мапе или компаса.

Направите добру документацију за сваку Бесплатни софтвер, отворени извор такође је корисно јер, иако документовање има трошакАко се правилно уради, инвестиција се исплати. Јер, свет софтвер је препун прича о застарели кодови старих или актуелних програма, апликација или система, којих се само мало људи усуђује додирнути, јер готово нико не разуме. Програмери се фокусирају на стварање кода, а не на његово правилно и потпуно документовање. И ово се мора исправити.

Добре праксе у вези са документацијом у текстуалним датотекама РЕАДМЕ

У случају Бесплатни софтвер и отворени код, документација је често ограничена на текстуалне датотеке, када је креирају појединци или мале групе програмера или заједнице. Али, до стварања једноставне документације помоћу једноставне текстуална датотека РЕАДМЕ.мд (или .ткт) можеш добити своје најбоље или добре праксе, савети или корисни водич за стварање како бисте трећим странама пружили најпотпуније и најдетаљније информације потребне о ономе што је створено.

За наш чланак смо узели Добра пракса осмислио и обелоданио "Кодекс за развојну иницијативу" дел Интерамерицан развојна банка, што укратко говори да добра документација заснована на а текстуална датотека РЕАДМЕ.мд (или .ткт) То мора бити структурирано на следећи начин:

Препоручена структура датотека РЕАДМЕ

  • Опис и контекст: Одељак у којем морате описати функционалности, контекст у коме је развијен и развојне проблеме које је помогао да се реши.
  • Кориснички водич: Одељак у којем треба поменути упутства крајњем кориснику о томе како да започне коришћење дигиталног алата.
  • Упутство за инсталацију: Одељак у коме треба поменути упутства за инсталацију за поновну употребу и конфигурисање дигиталног алата. Овај одељак је намењен програмерима.
  • autori Одељак у коме се сарадници на алату морају доделити кредити.
  • Лиценца за код алата: Одељак у којем се морају навести дозволе додељене трећим странама за поновну употребу дигиталног алата.
  • Лиценца за документацију алата: Одељак у којем се мора навести врста лиценце садржана у креираној документацији.

У овим добре праксе, они такође препоручују додавање у РЕАДМЕ документација датотеке да би био потпунији, следећи одељци:

  • Како допринети: Одељак који новим програмерима објашњава поступак доприноса пројектима.
  • Кодекс понашања: Одељак који објашњава кодекс понашања успоставља друштвене норме, правила и одговорности које појединци и организације морају следити када на било који начин комуницирају са дигиталним алатом или њиховом заједницом.
  • Значке: Одељак који приказује значке (мале слике уграђене у РЕАДМЕ.мд) које на читљив и сажет начин прецизирају стање алата.
  • Верзија: Одељак који указује на листу верзија дигиталног алата и функционалности додатих свакој верзији.
  • Захвалнице: Одељак који садржи признања другим људима или организацијама које су на неки начин допринеле пројекту.

Да бисте проширили ове информације, на Добра пракса у питањима документација за развој Слободни софтвер, од "Кодекс за развојну иницијативу" дел Интерамерицан развојна банка можете кликнути на следећу везу: Документација - Водич за објављивање дигиталних алата. А у другим публикацијама истражићемо део који се односи на добре праксе на процена и лиценцирање дел Бесплатни и отворени софтвер себе.

Закључак

Закључак

Надамо се да ово "користан мали пост" о «Buenas prácticas» у области «documentación» да ствара при развоју «Software libre y abierto», је од великог интереса и корисности, у целини «Comunidad de Software Libre y Código Abierto» и од великог доприноса ширењу дивног, гигантског и растућег екосистема примена и за «GNU/Linux».

А за више информација, не оклевајте увек да посетите било коју Интернет библиотека као ОпенЛибра y ЈедИТ читати књиге (ПДФ-ови) на ову тему или друге области знања. За сада, ако вам се свидело ово «publicación», немојте престати да је делите са другима, у вашем Омиљене веб локације, канали, групе или заједнице друштвених мрежа, по могућности бесплатних и отворених као Мастодонт, или сигурно и приватно Телеграм.

Или једноставно посетите нашу почетну страницу на ФромЛинук или се придружите званичном каналу Телеграм компаније ДесдеЛинук читати и гласати за ову или друге занимљиве публикације на «Software Libre», «Código Abierto», «GNU/Linux» и друге теме повезане са «Informática y la Computación», и «Actualidad tecnológica».


Садржај чланка се придржава наших принципа уређивачка етика. Да бисте пријавили грешку, кликните овде.

Будите први који ће коментарисати

Оставите свој коментар

Ваша емаил адреса неће бити објављена.

*

*

  1. За податке одговоран: Мигуел Ангел Гатон
  2. Сврха података: Контрола нежељене поште, управљање коментарима.
  3. Легитимација: Ваш пристанак
  4. Комуникација података: Подаци се неће преносити трећим лицима, осим по законској обавези.
  5. Похрана података: База података коју хостује Оццентус Нетворкс (ЕУ)
  6. Права: У било ком тренутку можете ограничити, опоравити и избрисати своје податке.