De ikke så skjulte fordelene med åpen innkjøp av dokumentasjonen

Hvorfor åpen kildekode ikke bare handler om kode Abby Cabunoc Mayes fra Mozilla Foundation forklarer hvorfor åpen kildekode handler om kultur like mye som det handler om kode.

De fleste tenker på åpen kildekode når det gjelder kode, men en av de mer interessante anvendelsene av utviklingsmetodikken er dokumentasjon. Du vet, det som gjør all den herlige koden brukbar av bare dødelige; det som gjør åpen kildekode, med andre ord, virkelig åpen.

Det forteller derfor at et av de 10 mest populære open source-prosjektene blant GitHubs 96 millioner depoter er Azure Docs. Det ville være fristende å se på dette som en kynisk form for sharecropping av åpen kildekode, en måte for en "virksomhet med flere milliarder dollar å spre belastningen med å opprettholde dokumenter." Men dette overser realiteten at brukere av programvaren ofte er de beste menneskene til å oppdatere dokumentene, og har en oppriktig interesse av å gjøre det.

Ingen dokumenter, ingen kode

Selv om det er sjelden å finne utviklere som liker å skrive god dokumentasjon så mye som de liker å skrive god kode, er det gode grunner til å gjøre dokumentasjonen over gjennomsnittet obligatorisk for programvare, open source eller proprietær. Som Adrian Ababei har skrevet inkluderer fordelene med stor dokumentasjon:

  • Koden din blir mer forståelig og gjenbrukbar
  • Flere utviklere vil ønske å bidra til prosjektets vekst
  • Totalt nybegynnere (for eksempel designere som vil forstå kodebasen) vil føle seg mer makt til å bruke programvaren din
  • Prosjektet ditt vil bli mer troverdig, og bygge sitt omdømme på GitHub

Kort sagt, hvis du vil at folk skal bruke programvaren din, bør du dokumentere det bedre. Det spiller ingen rolle hvor flott koden er hvis folk ikke finner "på" -knappen.

Som på mange andre områder har åpen kildekodeutviklere ledet veien for å forbedre hvordan dokumentasjonen blir skrevet. Som skissert av Shaun McCance, bruker utviklerne stadig mer Git for versjonskontroll, mens de skriver på lette språk. Hos Adobe (hvor jeg jobber) standardiserer vi Markdown ettersom både utviklere og ikke-tekniske produkt- eller markedsføringsfolk enkelt kan fange det. Andre verktøy eller prinsipper som statiske nettstedgeneratorer og kontinuerlig integrering avrunder trender, som hver gjør det enklere å publisere god dokumentasjon.

Men å komme til "flott" bringer oss tilbake til åpen kildekode.

Åpner dokumentene dine

Lisa Tagliaferri, som skrev på Digital Ocean-bloggen, har fremhevet en viktig årsak til å åpne for sine dokumenter:

Det kan være utfordrende for folk som er nær koden å forstå behovene til nye bidragsytere eller sluttbrukere. Ved å oppmuntre til bidrag fra forskjellige stemmer til dokumentasjonen din, vil prosjektet igjen bli mer nyttig for flere mennesker, slik at det når et bredere publikum. Å strebe etter å gjøre dokumentasjon inkluderende og tilgjengelig og oppsøke andres perspektiver kan også støtte å bringe flere utviklere og sluttbrukere til programvaren din.

I forbindelse med dette kan ingen utviklingsteam forutse de forskjellige måtene programvare vil bli brukt i projeksjonen. Åpning av døren for brukerbidrag gjør det dermed mulig for brukere å låne ut kompetansen sin til programvaren, og utlevere detaljer i dokumentene som ellers ville gå glipp av hvis de overlates til opplevelsen av det opprinnelige utviklingsteamet.

Etter min erfaring, setter disse brukerne - enten de er nybegynnere eller ekspert med den aktuelle programvaren - pris på sjansen til å dele det de vet med sine jevnaldrende og selskapet eller samfunnet som utvikler koden. De føler seg ikke misbrukt av prosessen. De føler eierskap.

Noe som selvfølgelig er en annen stor grunn til å åpne kildene til dokumentene dine: Et mer engasjert samfunn.

Ukens nyhetsbrev med åpen kildekode

Du vil ikke gå glipp av våre tips, opplæringsprogrammer og kommentarer til Linux OS og open source applikasjoner. Leveres tirsdager

Registrer deg i dag

© Copyright 2020 | mobilegn.com