3 formas de mejorar la documentación de su equipo abierto

Se organiza el Mes del Hardware Abierto Asociación de hardware con código abierto (OSHWA) cada octubre y este año prestamos atención a las formas de informar al mundo que su proyecto es de código abierto. Ayude a mantener un ecosistema de equipos abiertos ampliando la documentación de estas tres maneras este mes.

Índice

Documento

Si tiene un proyecto que aún no ha tenido tiempo de abrir, o si su documentación existente puede necesitar una conversión, ¡ahora es el momento! La documentación clara ayuda a los usuarios potenciales a encontrar, crear y contribuir potencialmente a su proyecto. Agrega fotos, repara enlaces rotos y sube archivos de diseño auxiliares Todas estas son formas de hacer que su proyecto sea más accesible.

Deberá proporcionar una licencia al publicar su documentación, ya que los derechos de autor se aplican automáticamente. Licencia, por ejemplo, de comunes creativos dará a otros la libertad de distribuir y modificar su documentación. Para preservar la definicion de comunidad Una licencia de hardware de código abierto no debe tener un elemento sobre no comercial o no derivado.

La publicación de su documentación también puede evitar futuras patentes al establecer un estado de la técnica. Si otra persona solicita una patente para un diseño similar, su documentación puede ayudar a reconocer su trabajo como un diseño original y evitar la concesión de una patente.

Etiqueta

¿Alguna vez ha encontrado un gran proyecto que parecía de código abierto pero no pudo encontrar una licencia en ninguna parte? El Abra la licencia de hardware lo ayuda a anunciar las licencias utilizadas en su proyecto, en un formato similar a la etiqueta de información nutricional de EE. UU. Enumerar sus licencias en un lugar destacado (como el LÉAME de su tienda) ayuda a los usuarios a saber de inmediato qué pueden y qué no pueden hacer con la fuente, en lugar de ver archivos individuales. Este es un complemento útil, aunque opcional, a la certificación OSHWA.

Certificar

Probablemente te hayas encontrado con proyectos que se anuncian a sí mismos como código abierto, pero, por extraño que parezca, falta gran parte del código fuente. El certificado OSHWA combate este problema (a veces llamado "lavado de autos abierto") al proporcionar a los creadores cuyos productos cumplen con la definición de hardware de código abierto la capacidad de agregar una marca de certificación con un identificador único. Esta marca brinda a los usuarios y clientes la confianza de que el producto es de código abierto y podrán estudiar, modificar y distribuir el código fuente. El programa de certificación también proporciona una catalogar proyectos certificados donde puede buscar detalles de un proyecto específico o buscar componentes para usar en su próximo proyecto. ¡Gracias a más de 200 creadores, este catálogo ha superado recientemente los 1.000 proyectos certificados!

Si su proyecto es de código abierto, debe gritarlo a los cuatro vientos con orgullo, y la documentación es en realidad la manera perfecta de hacerlo. Cuanto más documente y más clara sea la documentación, más legitimidad y protección brindará a su proyecto y su comunidad. Esto ayuda a los principiantes a saber exactamente con qué están trabajando y garantiza que el proyecto permanezca abierto. ¿Qué podría ser mejor para celebrar el Mes del Equipo Abierto?

Artículos de interés

Subir