Dokumentationsprojekt „Hydra Ecosystem“

Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
Hydra-Dokumentation
Technischer Redakteur:
AwesomeChap
Projektname:
Verbesserung der Nutzerfreundlichkeit der Website mit Dokumenten
Projektdauer:
Standardlaufzeit (3 Monate)

Projektbeschreibung

Ich möchte Ihnen mitteilen, dass ich an der Verbesserung der Nutzerfreundlichkeit der Docs-Website interessiert bin, die Sie auf der Seite mit Ideen für die Docs-Saison veröffentlicht haben. Ich bin erfahrener React-Entwickler, Designer und begeisterter Technischer Redakteur. Ich habe auch einige Erfahrung in der Arbeit in großen, interdisziplinären Teams. Neben der Entwicklung schreibe ich auch technische Blogs für einige Publikationen wie TheStartup. Meine Blogs finden Sie unter https://medium.com/@jatin15011999. Wenn Sie mehr über mich erfahren möchten, besuchen Sie meine Website www.jatinkumar.tech. Ich bin sicher, dass meine Erfahrung und meine Fähigkeiten gut zu dieser Idee passen.

Ich habe mehr als zwei Jahre Erfahrung mit MERN-Stack und kann ziemlich schnell robuste Benutzeroberflächen mit auffälliger Benutzeroberfläche und genialer Benutzeroberfläche erstellen. Ich bin mit React und Node.js vertraut und liebe es, Code mit Kreativität zu kombinieren. In meiner bisherigen Berufserfahrung habe ich verschiedene Front-End-Layouts entwickelt, mit denen verschiedene Probleme gelöst wurden. Als UI-/UX-Designer weiß ich sehr gut, wie viel Einfluss eine gute Website-UI/UX auf die Besucher haben kann. Es spielt keine Rolle, wie viele gute Inhalte Sie auf Ihrer Website haben, es sei denn, Sie können den Nutzern eine gute Nutzererfahrung bieten. Er würde Ihre Website nicht so gern wieder besuchen . Eine gute Benutzeroberfläche/UX kann so einfach sein wie das Ändern von Farben oder das Hinzufügen nicht aufdringlicher Animationen. Aber wenn Sie an diese einfachen Änderungen denken, müssen Sie Hunderte von Dingen ausprobieren, bevor Sie eine geeignete Kombination finden. Ich denke, ich habe über viel Erfahrung in diesem Aspekt und kann dies wirklich elegant und effizient umsetzen.

Ich habe mir die aktuelle Website von Hydra sehr genau angesehen und stimme voll und ganz zu, dass die aktuelle Website ein ernsthaftes Navigationsproblem aufweist. Wie in Ihrer Idee erwähnt, kann das Problem ganz einfach durch das Hinzufügen einer Seitenleiste oder einer Kopfleiste auf der Website behoben werden. Bei genauerer Betrachtung der aktuellen Website verfügt die aktuelle Website bereits über eine Navigationsleiste, die sich oben befindet, sodass die Topbar nicht angezeigt wird und die Seitenleiste sinnvoller zu sein scheint. Wie auf der Ideenseite beschrieben, müssen einige Dokumente zur einfacheren Navigation mit dem Startseitenbereich verknüpft werden. Unter Berücksichtigung all dieser Einschränkungen habe ich einen Prototyp entworfen. Sie können ihn unter http://hydra-doc.herokuapp.com/ sehen. Der Prototyp ist vollständig responsiv und wurde von verschiedenen anderen Dokumentationswebsites inspiriert. Die Nutzerfreundlichkeit ist auf einem Mobilgerät völlig anders als auf einem größeren Bildschirm wie einem Laptop. Wenn Sie den Prototyp gesehen haben, haben Sie vielleicht bemerkt, dass eine Landingpage (die auch eine „Über uns“-Seite ist) mit zwei Schaltflächen angezeigt wurde: „Weitere Informationen“ und „API-Dokumente“. Sehr gut. Unsere API-Dokumente wurden jetzt mit der Hauptseite verknüpft und eines der Probleme ist behoben. Aber wie sieht es mit der Navigation aus? Keine Sorge, diese Website bietet auch für diesen Aspekt eine sehr elegante Lösung. Wenn Sie jetzt auf die Schaltfläche „Weitere Informationen“ klicken, scrollen Sie zum Abschnitt „Über uns“ der Website. Wenn Sie jetzt herumspringen und damit spielen, werden Sie feststellen, wie elegant das Navigationsproblem gelöst wird, ohne die Sichtbarkeit der Inhalte und die Nutzerfreundlichkeit zu beeinträchtigen. Auf schmaleren Bildschirmen wird die Seitenleiste ausgeblendet, damit die Inhalte den benötigten Platz einnehmen. Auf breiteren Bildschirmen, auf denen Inhalte und Seitenleiste nebeneinander existieren können, nimmt die Seitenleiste ebenfalls den erforderlichen Platz ein. Wenn der Nutzer zu einer anderen Seite wechseln möchte, kann er das ganz einfach tun, indem er oben auf dem Bildschirm auf einen bestimmten Titel in der Navigationsleiste klickt. Nicht aufdringliche flüssige Animationen verbessern die Nutzerinteraktion und heben die UX der Website auf eine ganz neue Ebene.

Neben der Navigation ist auch der Inhaltsfluss ein Problem. Ich glaube, dass dieses Problem Zeit braucht, um gelöst zu werden. Aufgrund von Zeitmangel war es nicht möglich, daran zu arbeiten und sie in den oben bereitgestellten Prototyp zu integrieren. Aber ja, ich habe einige Ideen, wie der aktuelle Inhaltsfluss verbessert werden kann. Wenn noch Zeit bleibt, können wir auch die Art und Weise verbessern, wie Autoren derzeit Blogs und Anleitungen auf den Websites erstellen. Ich denke, dass ein Content-Management-System wie Medium das Problem sehr gut lösen könnte. Wenn sie erstellt werden, müssen wir keine Blogs auf Medium schreiben und sie dann auf medium.com weiterleiten. Das ist ziemlich ärgerlich, wenn Nutzer häufiger zwischen Blogs und der Hauptwebsite wechseln müssen. Wir könnten Blogs selbst hosten und Nutzer könnten einfacher zu Blogs gelangen. Außerdem hätten wir ein CMS, das mit dem von Medium vergleichbar ist, und Autoren könnten von ihnen erstellte Blogs oder Anleitungen ganz einfach bearbeiten.

Ich hoffe, dass Ihnen meine Idee gefallen hat. Ich denke, dass ich aufgrund meiner Erfahrung und meines Fachwissens gut für die Umsetzung dieser Idee geeignet bin.