Projet de documentation sur l'écosystème Hydra

Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.

Résumé du projet

Organisation Open Source:
Documentation de l'écosystème Hydra
Rédacteur technique:
AwesomeChap
Nom du projet:
Amélioration de l'expérience utilisateur du site de documents
Durée du projet:
Durée standard (trois mois)

Project description

Je vous contacte pour vous faire part de mon intérêt pour l'amélioration de l'expérience utilisateur de l'idée de site de documents que vous avez publiée sur votre page d'idées de saison de documents. Je suis un développeur et concepteur React chevronné, ainsi qu'un rédacteur technique très enthousiaste. J'ai également une bonne expérience du travail en équipe pluridisciplinaire. En plus du développement, j'écris des blogs techniques pour certaines publications comme TheStartup. Pour consulter mes blogs, accédez à https://medium.com/@jatin15011999. Pour en savoir plus sur moi, vous pouvez consulter mon site Web www.jatinkumar.tech. Je suis convaincu que mon expérience et mes compétences correspondent parfaitement à cette idée.

J'ai plus de deux ans d'expérience avec la pile MERN et je peux créer des interfaces robustes avec une UI attrayante et une UX exceptionnelle assez rapidement. Je maîtrise React et Node.js, et j'adore associer le code à la créativité. Au cours de mes expériences précédentes, j'ai développé différentes mises en page de front-end qui ont résolu divers problèmes. En tant que concepteur UI/UX, je sais très bien l'impact qu'une bonne interface utilisateur/expérience utilisateur peut avoir sur les visiteurs. Peu importe la quantité de contenu de qualité que vous pourriez avoir sur votre site Web, sauf si vous êtes en mesure d'offrir une bonne expérience utilisateur. Il/elle sera moins enclin à revenir sur votre site Web . Une bonne interface utilisateur ou expérience utilisateur peut être aussi simple que de changer les couleurs ou d'ajouter des animations non intrusives, mais pour penser à ces simples changements, vous devez essayer des centaines de choses avant de trouver la bonne combinaison. Je pense que j'ai une certaine expérience dans ce domaine et que je peux le faire de manière très élégante et efficace.

J'ai étudié le site Web actuel d'Hydra en détail et je suis le seul à penser que le site actuel présente un problème de navigation grave. Comme indiqué dans votre idée, vous pouvez facilement résoudre ce problème en ajoutant une barre latérale ou une barre supérieure au site Web. Toutefois, si nous examinons le site actuel de plus près, nous constatons qu'une barre de navigation est déjà située en haut. La barre de navigation n'est donc pas une option, et la barre latérale semble être plus adaptée. Comme indiqué sur la page "Idées", certains documents doivent également être liés à la section "Accueil" pour faciliter la navigation. Compte tenu de toutes ces contraintes, j'ai conçu un prototype, que vous pouvez consulter à l'adresse http://hydra-doc.herokuapp.com/. Le prototype est entièrement réactif et a été inspiré de divers sites de documentation. Il offre une expérience utilisateur complètement différente sur mobile par rapport à des écrans plus grands comme les ordinateurs portables. Si vous avez vu le prototype, vous avez peut-être remarqué qu'il a généré une page de destination (qui est également une page "À propos") avec deux boutons, l'un intitulé "En savoir plus" et l'autre "Documentation de l'API". Très bien. Il semble que nos documents d'API aient été associés à la page Web principale. L'un des problèmes est donc résolu. Mais qu'en est-il de la navigation ? Ne vous inquiétez pas, ce site propose également une solution très intéressante pour cet aspect. Si vous appuyez maintenant sur le bouton "En savoir plus", vous faites défiler l'écran jusqu'à la section "À propos" du site Web et je vous laisse le temps de vous amuser. Vous verrez par vous-même que cela résout le problème de navigation sans compromettre la visibilité du contenu ni l'expérience utilisateur. Sur les écrans plus fins, la barre latérale se cache et garantit que le contenu occupe l'espace qui lui revient. Sur les écrans plus larges, où le contenu et la barre latérale peuvent coexister, la barre latérale prend également de l'espace. Si l'utilisateur souhaite accéder à une autre page, il peut le faire très facilement en cliquant sur un titre dans la barre de navigation située en haut de l'écran. Les animations fluides et non intrusives améliorent l'interaction utilisateur et font passer l'expérience utilisateur du site Web à un tout autre niveau.

Outre la navigation, le flux de contenu est également un problème, et je pense qu'il a besoin de son temps pour le résoudre. En raison du manque de temps, je n'ai pas pu travailler dessus et l'intégrer au prototype fourni ci-dessus. Mais oui, j'ai de nombreuses idées pour améliorer le flux actuel du contenu. Si le temps le permet, nous pouvons également améliorer la façon dont les auteurs créent actuellement des blogs et des guides sur les sites Web. Je pense qu'un système de gestion de contenu comme Medium pourrait très bien résoudre le problème. Si nous en créons, nous n'aurons plus besoin d'écrire des articles sur Medium, puis de les rediriger vers medium.com, ce qui devient très gênant lorsque l'utilisateur doit passer plus fréquemment d'un blog au site principal . Nous pourrions héberger nous-mêmes des blogs et les utilisateurs pourraient y accéder plus facilement. En plus d'avoir un CMS comparable à celui de Medium, les auteurs pourraient également modifier très facilement les blogs ou les guides qu'ils ont créés.

J'espère que mon idée vous a plu et que je pense que mon expérience et mes compétences me permettront de travailler sur cette idée.