Original by Jake Cahill: https://blog.iota.org/iota-foundation-is-submitting-a-project-proposal-for-google-season-of-docs-27b83d257b4b (17.04.04.2020)

Die Dokumentation ist ein wichtiger Teil dessen, was wir bei der IOTA-Stiftung tun. Sie hilft unserer Gemeinschaft nicht nur, sich an dem, was wir aufbauen, zu beteiligen, sondern ist auch für die Adoption in der realen Welt unerlässlich.

Seit wir unser Dokumentationsportal eingerichtet haben, haben wir einige große Verbesserungen vorgenommen:

Wir haben neue Inhalte hinzugefügt, wie z.B. Bibliotheks-Workshops für Kunden mit Code, den Sie im Webbrowser ausführen können.

Wir haben mit Blick auf die Übersetzung geschrieben und stellen sicher, dass wir globales Englisch verwenden.

Wir haben die Plattform mit neuen Funktionen wie Nachrichtenboxen und einer zusätzlichen Navigationsebene verbessert.

In dem Maße, wie sich unsere Technologie verbessert und unsere Ambitionen wachsen, wachsen auch unsere Dokumentationsziele. Wir haben viele Ideen zur Verbesserung unserer Inhalte, und es wäre großartig, die Open-Source-Gemeinschaft einzubinden.

Aus diesem Grund bewerben wir uns dieses Jahr als Organisation für die Teilnahme an der Google Season of Docs!

Google Season of Docs ist ein Programm, das von Google durchgeführt wird, um technische Redakteure mit Open-Source-Organisationen in Verbindung zu bringen. Während des 3-6-monatigen Programms helfen technische Redakteure dabei, die Dokumentation einer Organisation zu verbessern, und im Gegenzug erhalten die Redakteure ein Stipendium von Google.

Wenn Sie mehr über uns erfahren möchten und wissen möchten, wie Sie sich beteiligen können, lesen Sie weiter.

Über die IOTA-Stiftung

Die IOTA Foundation ist eine gemeinnützige Organisation, deren Schwerpunkt auf der Standardisierung der IOTA-Technologie liegt, damit diese für ein globales, unerlaubtes Ökosystem eingesetzt werden kann.

Wir tun dies durch:

Befähigung des Einzelnen, frei, sicher und geschützt in einer digitalen Welt zu leben

Aufbau von unternehmenstauglichen Open-Source-Technologien für und mit der Gemeinschaft

Wachstum und Vernetzung unseres Ökosystems über Regionen und Branchen hinweg

Entwicklung von Lösungen, die nachhaltige, realitätsnahe Auswirkungen auf Industrie, Gesellschaft und Umwelt haben

Beitrag zu einer offenen und transparenten Politik, Praxis und Zusammenarbeit sowie Unterstützung von Regulierungsbehörden und öffentlichen Institutionen bei der Verwaltung neuer Technologien

Als Organisation sind wir eine von der Gemeinschaft geborene und von der Gemeinschaft getriebene Organisation, und wir beherbergen über 100 Open-Source-Software-Projekte.

Treffen Sie unser Team

Unser Team ist in 23 verschiedenen Ländern tätig. Die meisten von uns arbeiten aus der Ferne, so dass technische Redakteure problemlos von überall auf der Welt mit uns zusammenarbeiten können.

Die folgenden Teammitglieder werden die IOTA-Stiftung als Mentoren vertreten:

Jake Cahill

Technischer Redakteur

GitHub-Benutzername: JakeSCahill

Lewis Freiberg

Direktor für Ökosystem

GitHub-Benutzername: L3wi

Beteiligen Sie sich

Wir möchten, dass sich die technischen Redakteure während der diesjährigen Season of Docs mit der folgenden Projektidee befassen.

Die aufgelisteten Aufgaben wurden von unserem Team vorgeschlagen, aber wir sind mehr als glücklich über Vorschläge.

Wenn Sie sich beteiligen möchten, werfen Sie einen Blick auf unser Projekt und kontaktieren Sie uns unter jake.cahill@iota.org.

Projektidee: Verbessern Sie unsere Entwicklerdokumentation

Ein wesentlicher Teil unserer Mission beruht auf Entwicklern, die sich unsere Technologie aneignen und damit Dinge bauen, weshalb wir unser Dokumentationsportal für Entwickler aufgebaut haben.

In diesem Jahr wird die IOTA Foundation eine Reihe neuer Produkte und auch einige bahnbrechende Änderungen am IOTA-Protokoll veröffentlichen. Diese Änderungen werden einen großen Einfluss auf unsere bestehende Dokumentation haben.

Dies ist eine großartige Gelegenheit für einen technischen Redakteur, mit uns zusammenzuarbeiten:

unsere Informationsarchitektur zu überprüfen und umzugestalten, um den Benutzern zu helfen, das zu finden, was sie suchen.

Hilfe bei der Gestaltung einer Landing Page mit den wichtigsten Vorteilen unserer Technologie und Einstiegspunkten für unsere verschiedenen Benutzer.

Erstellen Sie wiederverwendbare Vorlagen und hosten Sie diese auf unserem GitHub-Repository.

Prüfen Sie, wie wir unsere Plattformwerkzeuge verbessern können, z.B. um unseren Inhalt besser auszuwerten oder um bedingten Text und globale Variablen zu ermöglichen. Wir sind offen für die Erforschung von Techniken der Verarbeitung natürlicher Sprache, KI und maschinellen Lernverfahren zusätzlich zu traditioneller Software.

Verwandtes Material

Unsere aktuelle Dokumentation wird auf docs.iota.org angezeigt und im iotaledger/documentation gehostet.

Wir haben auch einen style guide und einen Leitfaden, um neuen Beitragenden den Einstieg zu erleichtern.

Wir planen, die Dokumentation zu übersetzen. Deshalb folgen wir auch dem Global English Style Guide von John R. Kohl.

Der Plattformcode befindet sich im iotaledger/documentation-platform repository.

Teilen mit: Twitter

Facebook

Reddit

Telegram

Tumblr

LinkedIn

Pinterest

