Open Source It Manual Vs 1.1

(en;de)

Tada! Version 1.1 des OWi Open Source It Manuals ist da. Die neue Version ist inspiriert von einigen Quellen, die erst nach der Veröffentlichung von Version 1.0 entdeckt wurden, die wichtigste Quelle sind sicher die „Open Source Hardware Best Practices“ von der Open Source Hardware Association und Nathan Seidle (Sparkfun). Das Manual ist immer noch nicht perfekt – ich bin sicher. Wir werden weiter daran arbeiten und versuchen, für die nächste Version mehr Leute mit einzubeziehen. Bleibt dran oder werdet Teil der Entwicklung.

Der Manualtext ist unten gepostet. Auf der Seite aber ist die aktuellste Version.

****

/* english */

Tada! Version 1.1 of the OWi Open Source It Manual is out. This time it is inspired by some sources that were found after Vs 1.0 was published. Most important was the Open Source Hardware Best Practices by the Open Source Hardware Association and Nathan Seidle (Sparkfun). The Manual is not ready – i am shure. We will continue working on it and bring for the next version some more minds to the task. Stay tuned or join the process.

The Text of the Manual is posted below. Scroll down to the english version. But the most current version you find probably at the Open Source it Manual Webpage.

 

DE

Open Source It Manual (Open Source it Anleitung) Vs 1.1

english, PDF Download

Open source it! Open sourced euer Projekt, euren Prozess, euer Produkt. Dieses Manual (Manual = Anleitung) gibt Hinweise dafür und nennt Grundannahmen.

Hier liegt die aktuelle Version 1.1 vor. Sie ist inspiriert vom Open Source it Manual Vs 1.0, den Open Source Hardware Best Practices der OSHWA (exakte Übernahme in Punkt 2.4, 3.2, 3.3 & 4.1) und dem Makers Bill of Rights. Weiterentwicklungen sind geplant; neue Veröffentlichungen werden mit einer neuen Versionsnummer versehen.

>

Präambel

(1) Open Source. Open Source ist ein Beitrag für eine innovativere, sozialere und ökonomisch nachhaltigere Wirtschaft. Nehmt teil an der Entwicklung.

(2) Definition. Open Source bedeutet, dass die Informationen, die zur Herstellung und Weiterentwicklung einer Sache notwendig sind wie z.B. Baupläne, Rezepturen, Design-Dateien usw. öffentlich zugänglich gemacht sind und jedem erlaubt und möglich ist, sie zu studieren, sie weiterzuverbreiten, sie zu modifizieren und darauf basierende Dinge herzustellen bzw. umzusetzen und jede dieser Tätigkeiten falls gewünscht auch kommerziell auszuführen. > Siehe Open Source Hardware Definition und Statement of Principles.

(3) Freiheit. Der Kern von Open Source ist also das Teilen von Informationen in einer Weise, die andere befähigt bzw. ihnen Möglichkeiten gibt. Open Source gibt Wissen und damit Menschen Freiheit. Darin liegt die Kraft von Open Source. Je größer die Offenheit und damit Freiheit von Informationen ist, desto stärker wird Open Source. Dieses Manual beschreibt fünf Dimensionen, die die Offenheit und Freiheit von Informationen bestimmen. 1. Die Software-Tools mit denen die Informationen erstellt sind und die dabei verwendeten Dateiformate: 2. Die Bauweise der Dinge selbst 3. Die Qualität der Aufbereitung der Informationen 4. Die Lizenz und 5. die Auffindbarkeit bzw. Vernetztheit der Informationen. Zu allem wird hier etwas gesagt. Je mehr der folgenden Punkte und je umfassender sie erfüllt werden können, desto größer wird die Freiheit und Offenheit der Informationen und der beschriebenen Sache in der Regel hinterher sein.

1. Softwaretools und Dateiformate

(1)    Freie Dateiformate und Tools. Arbeitet mit und veröffentlicht in Dateiformaten, die jedermann leicht lesen und bearbeiten kann, weil die dafür notwendigen Programme frei verfügbar ist. Offene Formate und Programme sind vorzuziehen. Wo das nicht möglich ist, weicht auf preisgünstige und leicht zu beschaffende Alternativen aus.

(2)    Bearbeitbarkeit. Die Informationen sollten in einem Dateiformat zur Verfügung stehen, das eine Bearbeitung erlaubt. Im Zweifelsfall sind die Orginaldateien aus der Entwicklung die beste Wahl.

(3)    Konvertierbarkeit. Wo immer möglich, wählt Dateiformate aus, die leicht in andere Dateiformate umgewandelt/konvertiert werden können.

(4)    Übertragbarkeit. Stellt die Informationen in einer Weise zur Verfügung, die es leicht macht, sie zu kopieren und woanders neu hochzuladen und verfügbar zu machen (sie zu spiegeln).

(5)    Plattformunabhängigkeit! Ein allgemeines Maß für die Freiheit der Tools und Formate, die Bearbeitbarkeit, Konvertierbarkeit und Übertragbarkeit ist Plattformunabhängigkeit. Die Informationen sollten so weit wie möglich unabhängig sein von einer festgelegten Publikationsweise und einem festgelegten Publikationsort, sondern frei sein, Grenzen zu überspringen. Im Transfer der Informationen zwischen verschiedenen Websites, Servern, Trägern, Formaten und Darstellungsweisen verwirklicht sich ihre Freiheit. Freiheit, wie sie von diesem Manual angeleitet wird. Freiheit ist die beste Plattform!

(6)    Kollaboration. Wir wissen, dass die verfügbaren Werkzeuge und Techniken für die offene Dokumentation, Kommunikation und kollaborative Entwicklung von physischen Objekten und Verfahren gegenwärtig wenig ausgereift sind. Helft bei der Entwicklung: Gebt neuen Ideen eine Chance, spielt damit und experimentiert. Behaltet dabei die Ideen dieses Manuals im Hinterkopf. Sucht und wählt Lösungen, die ihr am besten und umfänglichsten kontrollieren könnt. Das Manual selbst empfiehlt keine bestimmte Plattform oder bestimmte Formatierungen. Sammlungen mit Hinweisen sind aber andernorts verfügbar.  (Update: siehe unten am Seitenende)

2. Bauweise

(1)    Komponenten- und Materialverfügbarkeit. Wählt für die Konstruktion des Objektes oder den Aufbau des Verfahrens Komponenten und Materialien aus, die allgemein zugänglich sind, d.h. von jedermann leicht gefunden und gekauft werden können. Wo das nicht möglich ist, gebt Hinweise, wie und wo man Fehlendes beschaffen oder eventuell ersetzen kann.

(2)    Nachvollziehbarer Aufbau. Gestaltet den Aufbau bzw. die Konstruktion möglichst übersichtlich und nachvollziehbar. Wo möglich nutzt und folgt allgemeinen Standards. Reparierbarkeit ist ein sinnvolles Designideal: Ist Fehlersuche möglich, kann man Einzelteile austauschen, ist alles wieder leicht voneinander zu lösen usw.

(3)    Standardwerkzeuge und –prozesse. Wann immer möglich, sollten bei der Konstruktion Werkzeuge und Prozesse zur Anwendung kommen, die allgemein verfügbar und leicht und preisgünstig zu beschaffen sind. Wo ihr davon abweichen müsst, gebt Hinweise, wo eventuelles Spezialwerkzeug beschafft oder selbst hergestellt bzw. wie Prozesse eingerichtet werden können.

(4)    Versionsnummern. Verseht Produkte oder Exemplare mit einer Versionsnummer oder einem Veröffentlichungsdatum, damit fertige Objekte leicht mit den richtigen bzw. dafür gültigen Information in Verbindung gebracht werden können.

3. Aufbereitung der Informationen

(1)    Verständliche Darstellung. Bemüht euch die Informationen möglichst verständlich und zugänglich aufzubereiten. Versucht logisch zu gliedern, kommentiert ungewöhnliche Aspekte, macht Voraussetzungen klar, wählt wo möglich eine allgemein verständliche Sprache. Vermeidet exotische Darstellungsweisen, sondern zieht gebräuchliche und zugängliche wie z.B. Fotos, Tabellen, Listen, Überschriften usw. vor.

(2)    Überblick/Einführung. Wenn die Darstellungen kompliziert sind und mehrere Dokumente umfassen, stellt eine allgemeine Einführung voran. Worum handelt es sich? Welche allgemeine Idee und Intention steht hinter der Sache? Ein Bild oder Rendering kann hier für den Einstieg sehr hilfreich sein.

(3)    Stückliste. Fügt eine separate Stückliste (Zutatenliste) mit allen notwendigen Teilen bei. Die Liste kann auch Zusatzangaben enthalten zu den einzelnen Teilen wie z.B. Versionsnummern, Kurzbeschreibung, Kosten, Bezugsquelle usw. Stellt sicher, dass es einfach ist, zu erkennen, welches Teil auf der Liste welche Rolle in der Konstruktion spielt. Verwendet die gleichen oder aufeinander bezogene Bezeichnungen an beiden Orten.

4. Die Lizenzierung

(1)    Lizenzen nutzen. Markiert Offenheit mit einer Lizenz. Lizenzen regeln Nutzungsrechte. Mit einer entsprechenden offenen Lizenz, könnt ihr anderen kommunizieren, dass sie eure Werke kopieren und damit arbeiten dürfen, was ihnen, wenn ihr keine Lizenz anfügt, nicht erlaubt ist. Lizenzen sind also ein Weg, anderen Freiheiten zu geben und ihnen dafür Bedingungen aufzuerlegen. Lizenzierung ist ein komplexes Thema. Es ist wichtig, zu wissen, dass die meisten Open Source relevanten Lizenzen auf dem Urheberrecht beruhen und damit i.d.R. nicht auf physische Objekte/Hardware selbst angewendet werden können, sondern nur für Design-Dateien und Beschreibungen gelten. Die in der Beschreibung dargelegten Funktionalitäten sind davon nicht berührt. Darum ist es rechtlich unklar, welchen Schutz urheberrechtsbasierte Lizenzen tatsächlich für Hardware und Hardware-Design-Dateien bieten. Die Nutzung einer Open Source/Open Hardware Lizenz ist aber dennoch ein wichtiger Weg, anderen deutlich zu machen, wie ihr wollt, dass sie eure Entwicklungen verwenden.

(2)    Eine Lizenz auswählen. Es gibt heute verschiedene Lizenzen zur Auswahl. Wählt eine Lizenz, die die hier unter 1.2 und von der Open Source Hardware Definition genannten Freiheiten vollständig gewährt. Allgemein ist der Offenheits- und Freiheitseffekt einer Lizenz um so höher ist, je einfacher die Lizenz ist, d.h. je weniger Einschränkungen und Bedingungen sie enthält. Das Feld der Lizenzen bleibt in Entwicklung. Aktuelle Beispiele für geeignete Lizenzen sind:

a.    die Creative Commons Attribution Lizenz (CC-BY),
b.    die Creative Commons Attribution-ShareAlike Lizenz (CC-BY-SA),
c.    die GNU General Public Licence (GPL),
d.    die TAPR OHL,
e.    die CERN OHL und
f.    die FreeBSD Licence.

(3)    Lizenzvermerk. Bringt den Lizenzvermerk deutlich sichtbar an. Die Lizenz sollte für jeden schnell und ohne langes Suchen zu finden sein. Offene Lizenzen und ein deutlicher Vermerk darüber sind ein Botschafter für Open Source und euer Anliegen.

(4)    Lizenzen achten. Wenn ihr auf die Arbeit anderer aufbaut, achtet darauf, die Bedingungen der dort gewählten Lizenz einzuhalten. Nehmt die Arbeit in Kauf. Bringt vor allem die Namensnennungen korrekt und prominent an. Dies stärkt das Vertrauen, die Zusammenarbeit und der Entwicklung der offenen Open Source Kultur.

5. Auffindbarkeit und Vernetztheit

(1)    Vernetzung. Damit Open Source bzw. die Offenheit eurer Sache auch gut funktioniert, ist es wichtig, das andere eure Inhalte auch finden können. Das Finden der Informationen ist der erste Schritt zum Austausch, wechselseitigen Lernen und zur Kollaboration. Es gibt eine Vielzahl von Dingen, die hierfür wirksam sind, technische und soziale. Sie können hier nicht alle dargestellt werden. Einige gute allgemeine Hinweise für den Einstieg sind aber:

a.    Werbung. Werbt für euer Projekt, verbreitet es im Netz mit den Social Media Tools eurer Wahl etc. Sprecht mit Leuten darüber.
b.    Macht die Informationen auf den Internetseiten der Produkte einfach zu finden und schreibt den Link dahin auch auf das Produkt bzw. seine Ver- und Beipackungen.
c.    Beschäftigt euch bei der Erstellung eurer Seite mit den Grundzügen von Suchmaschinenoptimierung. Verwendet die richtigen Worte. Wonach würden Leute suchen usw.
d.    Schaut euch andere Open Source Projekte an und sucht Kontakt.
e.    Experimentiert! Probiert neue Vernetzungstechniken aus. >> Dieses Manual hat einen eigenen Vorschlag für eine Vernetzungstechnik/ein Vernetzungsexperiment: Verlinkt es von euren Seiten aus. Ein guter Ort dafür ist z.B. in der Nähe der Lizenz. Die Verlinkung und Verbreitung des Open Source It Manuals erklärt allen schnell, wie euer Projekt funktioniert und wie Open Source an sich funktioniert. Menschen begegnen der Idee und lernen dabei gleich selbst, wie sie ein eigenes Open Source-Projekt aufsetzen können. Unten könnt ihr euch dafür den Button herunterladen und html Code kopieren und bei euch einfügen.

1. Jan. 2014

 

Embed Code

osim button-88x56  88x56px

<a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-deutsch/"><img alt="Open Source It Manual" style="border-width:0" src="http://owiowi.net/wp-content/uploads/2014/01/osim-button-88x56.png" /></a><br /><a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-deutsch/">Open Source It Manual</a>

osim button-120x76 120x76px

<a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-deutsch/"><img alt="Open Source It Manual" style="border-width:0" src="http://owiowi.net/wp-content/uploads/2014/01/osim-button-120x76.png" /></a><br /><a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-deutsch/">Open Source It Manual</a>

HIER KLICKEN für verschiedene Farben, Größen und die Original Vektordatei

diffcol&siz_osim

<>

Tools/Links

Frühere Manual-Versionen: Vs1.0

 

EN

Open Source It Manual Vs 1.1

deutsch, PDF Download

Open Source it! Open source your product, design, project or process. This manual shares suggestions and basis assumptions for this.

This is the version number 1.1 of the manual. It is inspired Open Source it Manual Vs. 1.0, the Best Practices for Open Source Hardware of the Open Source Hardware Association (direct copies in point 2.4, 3.2, 3.3 & 4.1) and the Makers Bill of Rights. It will be developed further. New versions will be published with a unique version number.

(This is a nonprofessional translation of the OWi Open Source it Manual from the german original. Please excuse the quality. If you like to help to make it better please don’t hesitate to contact us.)

Preamble

(1)    Open Source. Open Source is a contribution and attempt towards a more innovative,  more social and economical sustainable economy. Become a part, join the progress.

(2)    Definition. Open Source means to publish information like design files for physical objects and production processes. The publication should happen in a way, that allows and enables everybody to study the information, modify it, distribute it and build things based on it and do all of this in a commercial way if wanted. >See the Open Source Hardware Open Source Hardware Definition and Statement of Principles.

(3)    Freedom. Sharing information in a way that enables others is the heart of Open Source. It is about freedom for knowledge and people. This is the power of Open Source. The bigger the freedom and openness of the information is the stronger becomes Open Source. This manual describes five things that determine openness and freedom: 1. the software-tools that were used to create the information and the data formats the information is in 2. the design of the hardware or object itself 3. the structure and quality of the information 4. the licence the information is under and 5. the findability or connectedness of the information. On every point you will find something in the manual. The more things you can follow the bigger the freedom and openness of your information and design will be in the end.

1. Software-tools and data-formats

(1)    Free tools and data formats. Use data formats that can easily be read and modified by everybody because the software to do this is free and accessible. Open data formats and tools should be preferred. If this is not possible use cheap and easy to get alternatives.

(2)    Modifiability. Publish your information in formats that make modification possible and easy. The original design files are probably the best choice.

(3)    Convertibility. Chose whenever possible formats that are easy to convert into other formats.

(4)    Portability. Make your information available in a way that makes it easy to copy them, transmit them and republish (mirror) them someplace else.

(5)    Platform-independency. A simple and summing up measure for the freedom of tools, the modifiability, the convertability and the portability is „platform-independency“. Try to publish your information in a way that they are as far as possible indpendent from a certain publication format or publication place but ready to cross borders. The freedom and openness of the information comes true when it is transferred between different websites, platforms, servers, carriers and formats. Freedom as teached in this manual. Freedom is the best platform!

(6)    Collaboration. We know that the available tools and techniques for open documentation, communication and collaborative development of hardware and processes are not in an optimal stage nowadays. Help to make them better: Play with new ideas, give them a chance and test. Keep this manual in mind and search for ideas and ways that give you extended control. The manual itself does not recommend certain platforms or formats. But you will probably find lists with links and hinds somewhere around. (Update: scroll down to find some helpful links)

2. The design of the object itself

(1)    Availability of components and materials. Chose for your design where possible components and materials that are accessible (easy to find and to buy) for most people. Where this is not possible give hinds how and where to get things or how to substitute them.

(2)    Understandable structure. Create the design in a way that it is clear and easy to understand for someone else. Use widely known standards. Ease of repair could be a good design ideal as well. Is it easy to debug, is it easy to dismantle, are single components and parts replaceable?

(3)    Standards. Try to make sure that the construction only needs tools and processes that are generally available, cheap to buy or easy to set up. Use standards whenever possible. Where this is not possible give hinds where to get special tools or how to set everything up step by step.

(4)    Version number. Label the product with a version number or release date so that people can match the physical object with the corresponding version of its design files.

3. The design of the information

(1)    Understandable information. Try to make your design files easy for someone else to understand. Organize them in a logical way; use an easy language, avoid exotic information-designs and use instead common and easy to create things like photos, charts, lists, headlines etc.

(2)    Overview/Introduction. If the thing is complex, your open-source project should include a general description of the hardware’s identity and purpose, written as much as possible for a general audience. That is, explain what the project is and what it’s for before you get into the technical details. Add a good photo or rendering if you have one.

(3)    Bill of materials. Provide a separate bill of materials. Useful things to include in the bill of materials are part numbers, suppliers, costs, and a short description of each part. Make it easy to tell which item in the bill of materials corresponds to which component in your design files: use matching reference designators in both places.

4. Licencing

(1)    Use a licence. Use a licence to make your design open. Licences tell something about rights of use. With a licence you give people rights that they would not have without the licence. By explicitly applying an open-source license to your hardware design files and other documentation, you make it clear that others can copy and modify them. Note that copyright (on which most licenses are based) doesn’t apply to hardware itself, only to the design files for it – and, then, only to the elements which constitute “original works of authorship” (in U.S. law) and not the underlying functionality or ideas. Therefore, it’s not entirely clear exactly which legal protections are or aren’t afforded by the use of a copyright-based license for hardware design files. While licensing is a complex subject, use of licenses is an important way of signalling how others can and should use your work.

(2)    Choosing a licence. There are different licences out there. Make sure to choose one that grants all the freedoms mentioned here under 1.2 and by the Open Source Hardware Definition and Statement of Principles. In general one can say that a licence enables the more openness and freedom the less limitations and conditions it contains. The area of licences is in constant development. Current examples of suiting licences are:

a.    the Creative Commons Attribution Lizenz (CC-BY),
b.    the Creative Commons Attribution-ShareAlike Lizenz (CC-BY-SA),
c.    the GNU General Public Licence (GPL),
d.    the TAPR OHL,
e.    the CERN OHL and
f.     the FreeBSD Licence.

(3)    Licence remark. Put the licence remark prominent on all your design files and web pages. Everybody should be able to find it immediately. Prominent placed open licence remarks are an ambassador for openness and a multiplier of your open source intentions.

(4)    Follow the licence. If you build upon the work of others watch carefully that you meet all the requirements of their licence. Take your time for the attribution and chose a prominent spot for it. This builds trust, collaboration and pushes the development of an open source culture.

5. findability or connectedness

(1)    Spreading and connecting. In order to make the openness of your product or project work best you need to make sure, that others can and will find it. Finding information is the first step to an interconnected learning and collaboration process. There are a lot of things you can do for this, technical as well as social things. This manual can’t cover them all. But these hints are for sure a good start:

a.    Advertize. Advertize your project, use the web and social media to do it. Talk to people.
b.    Make the information easy to find on your webpages and put a link on the product or the package and your broshures etc.
c.    Read something about Search Engine Optimization. Use the right words; what would people search the web for etc.
d.    Study other open source projects and contact them if they inspire you.
e.    Experiment! Test new networking techniques: >> This manual has an offer for an networking-experiment as well: Link to the manual from your pages. Linking to the manual is a good way to show others how your project and open source in general works. And by that they also learn how to create their own open source project tomorrow. A good place for the link could be right next to your licence remark. You can download a button for this below and also copy some html for your page.

1. Jan. 2014

<>

Embed Code

osim button-88x56  88x56px

<a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-english/"><img alt="Open Source It Manual" style="border-width:0" src="http://owiowi.net/wp-content/uploads/2014/01/osim-button-88x56.png" /></a><br /><a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-english/">Open Source It Manual</a>

osim button-120x76 120x76px

<a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-english/"><img alt="Open Source It Manual" style="border-width:0" src="http://owiowi.net/wp-content/uploads/2014/01/osim-button-120x76.png" /></a><br /><a rel="open source it manual" href="http://owiowi.net/open-source-it-manual-english/">Open Source It Manual</a>

CLICK here for different colors, sizes and the vector file

diffcol&siz_osim

[>]

Tools/Links