3 способа улучшить вашу открытую документацию по оборудованию

Месяц открытого оборудования проводится Ассоциацией оборудования с открытым исходным кодом (OSHWA) каждый октябрь, и в этом году мы уделяем внимание способам сообщить миру, что ваш проект имеет открытый исходный код. Помогите поддержать открытую аппаратную экосистему, пополнив свою документацию этими тремя способами в течение этого месяца.

Документ

Если у вас есть проект, у которого еще нет возможности открыть исходный код, или ваша существующая документация может быть изменена, сейчас самое время! Четкая документация помогает потенциальным пользователям находить, создавать и вносить свой вклад в ваш проект. Добавление изображений, восстановление неработающих ссылок и загрузка вспомогательных файлов дизайна - все это способы сделать ваш проект более доступным.

При публикации документации вам необходимо указать лицензию, поскольку авторские права применяются автоматически. Такая лицензия, как лицензия Creative Commons, предоставит другим свободу распространять и изменять вашу документацию. Чтобы соответствовать определению оборудования с открытым исходным кодом, принятому сообществом, в лицензии не должно быть положений о некоммерческих или производных инструментах.

Публикация вашей документации также может предотвратить будущие патенты, установив уровень техники. Если кто-то другой подает заявку на патент на аналогичный образец, ваша документация может помочь сделать вашу работу оригинальной и предотвратить выдачу патента.

Лэйбл

Вы когда-нибудь находили восхитительный проект с открытым исходным кодом, но нигде не могли найти лицензию? Этикетка Open Hardware License Label помогает вам декларировать лицензии, используемые в вашем проекте, в формате, аналогичном этикетке US Nutrition Facts. Размещение ваших лицензий в одном заметном месте (например, в README вашего репозитория) помогает пользователям сразу узнать, что они могут и не могут делать с источником, вместо того, чтобы просматривать отдельные файлы. Это полезное, хотя и необязательное дополнение к сертификации OSHWA.

Сертифицировать

Вы, вероятно, сталкивались с проектами, которые рекламируют себя как открытый исходный код, но большая часть исходного кода, как ни странно, отсутствует. Сертификация OSHWA борется с этой проблемой (иногда называемой «открытой промывкой»), предоставляя разработчикам, чьи продукты соответствуют определению оборудования с открытым исходным кодом, возможность добавить знак сертификации с уникальным идентификатором. Этот знак дает пользователям и клиентам уверенность в том, что исходный код продукта действительно открыт, и они смогут изучать, изменять и распространять исходный код. Программа сертификации также предоставляет каталог сертифицированных проектов, где вы можете просмотреть подробную информацию о конкретном проекте или найти компоненты для использования в следующем проекте. Благодаря более чем 200 создателям этот каталог недавно превысил 1000 сертифицированных проектов!
Если ваш проект имеет открытый исходный код, вы должны с гордостью кричать о нем с крыш, и документация - идеальный способ для этого. Чем больше вы документируете и чем четче эта документация, тем больше легитимности и защиты вы предоставляете своему проекту и его сообществу. Это помогает новичкам точно знать, с чем они работают, и гарантирует, что проект останется открытым. Что может быть лучше для празднования Месяца открытого оборудования?