Ricerca nel sito web

3 modi per migliorare la documentazione dell'hardware aperto


La documentazione è una base importante per qualsiasi progetto open source, per guidare la tua comunità e mantenerla aperta.

L'Open Hardware Month è organizzato ogni ottobre dalla Open Source Hardware Association (OSHWA) e quest'anno puntiamo i riflettori sui modi per dire al mondo che il tuo progetto è open source. Aiutaci a supportare l'ecosistema hardware aperto rafforzando la tua documentazione in questi tre modi durante questo mese.

Documento

Se hai un progetto che non sei ancora riuscito a rendere open source, o la tua documentazione esistente potrebbe aver bisogno di un restyling, ora è il momento! Una documentazione chiara aiuta i potenziali utenti a trovare, creare e potenzialmente contribuire al tuo progetto. Aggiungere immagini, riparare collegamenti interrotti e caricare file di progettazione ausiliari sono tutti modi per rendere il tuo progetto più accessibile.

Quando pubblichi la tua documentazione, dovrai specificare una licenza poiché il copyright si applica automaticamente. Una licenza come quella di Creative Commons garantirà ad altri la libertà di distribuire e modificare la tua documentazione. Per rispettare la definizione comunitaria di hardware open source, la licenza non deve contenere clausole non commerciali o non derivate.

Pubblicare la documentazione può anche impedire futuri brevetti stabilendo lo stato dell'arte. Se qualcun altro richiede un brevetto per un design simile, la tua documentazione potrebbe aiutare a stabilire che il tuo lavoro è il design originale e impedire la concessione del brevetto.

Etichetta

Hai mai trovato un progetto delizioso che sembrava essere open source, ma non sei riuscito a trovare una licenza da nessuna parte? L'etichetta Open Hardware License ti aiuta a dichiarare le licenze utilizzate nel tuo progetto utilizzando un formato simile all'etichetta Nutrition Facts degli Stati Uniti. Elencare le tue licenze in un posto ben visibile (come il README del tuo repository) aiuta gli utenti a sapere immediatamente cosa possono e non possono fare con la fonte, piuttosto che dover sfogliare i singoli file. Questo è un complemento utile, anche se facoltativo, alla certificazione OSHWA.

Certificare

Probabilmente ti sei imbattuto in progetti che si pubblicizzano come open source, ma curiosamente manca gran parte del codice sorgente. La certificazione OSHWA combatte questo problema (a volte chiamato "open-washing") fornendo ai creatori i cui prodotti soddisfano la definizione di hardware open source un modo per aggiungere un marchio di certificazione con un identificatore univoco. Questo marchio dà agli utenti e ai clienti la certezza che il prodotto è effettivamente open source e che saranno in grado di studiare, modificare e distribuire il codice sorgente. Il programma di certificazione fornisce anche una directory di progetti certificati in cui è possibile consultare i dettagli di un progetto specifico o cercare componenti da utilizzare nel progetto successivo. Grazie a oltre 200 creatori, questa directory ha recentemente superato i 1.000 progetti certificati!

Se il tuo progetto è open source, dovresti gridarlo ai quattro venti con orgoglio, e la documentazione è in realtà un modo perfetto per farlo. Più documenti, e più chiara è la documentazione, maggiore sarà la legittimità e la protezione che offri al tuo progetto e alla sua comunità. Aiuta i nuovi arrivati a sapere esattamente su cosa stanno lavorando e garantisce che il progetto rimanga aperto. Quale modo migliore potrebbe esserci per celebrare l'Open Hardware Month?

Articoli correlati: