Cette page contient les détails d'un projet de rédaction technique accepté pour la saison des documents Google.
Résumé du projet
- Organisation Open Source:
- Langage Julia
- Rédacteur technique:
- mkg33
- Nom du projet:
- Documentation unifiée du machine learning scientifique
- Durée du projet:
- Longue durée (5 mois)
Project description
J'aimerais travailler sur l'unification de l'organisation SciML, car il y a beaucoup de possibilités d'amélioration dans ce domaine et la réalisation de ce projet offrira sans aucun doute des avantages immédiats aux programmeurs de Julia et aux contributeurs/gestionnaires actifs de SciML. Les packages dispersés dans SciML offrent des outils vraiment utiles, mais il existe toujours un risque qu'ils passent inaperçus (en particulier par les nouveaux utilisateurs) simplement parce que l'utilisateur n'a pas pu découvrir le package et l'appliquer au problème en question.
Cette situation est plutôt frustrante, car l'objectif principal des packages est de toucher un large public de programmeurs, débutants comme experts. Pour éviter la situation décrite ci-dessus, je propose de réviser en profondeur la "page d'accueil" de la documentation SciML et de créer une sorte de hub que les utilisateurs pourraient utiliser pour parcourir les packages associés et explorer l'écosystème en pleine croissance. Cela pourrait également servir de point de référence précieux pour les utilisateurs plus expérimentés et leur permettre de travailler plus efficacement.
Tout d'abord, la documentation existante de chaque package doit être révisée en ce qui concerne les problèmes stylistiques les plus élémentaires (orthographe, ponctuation, grammaire, etc.). Pour assurer la cohérence stylistique, SciML doit disposer d'un guide de style concret (indispensable pour apporter des modifications rétrospectives et pour référence future). Ce serait un gaspillage de temps de repartir de zéro. Il doit plutôt être basé sur les conventions Julia existantes et inclure de nouvelles entrées pour les problèmes spécifiques à SciML.
Une fois le guide de style terminé, je prévois de réviser la documentation actuelle lors de la deuxième phase du projet. La documentation sera ainsi plus professionnelle et stable. J'ai déjà créé plusieurs requêtes pull qui illustrent mon approche de cette tâche. Au cours de cette phase, je compte également concevoir (et implémenter) un système de citation efficace. La toute première tâche consistera à mettre à jour la page des citations obsolètes.
La troisième phase, qui est sans doute la plus importante, consistera à concevoir la feuille de route SciML, qui mettra l'accent sur l'interaction entre les packages dispersés. Plus la cohésion entre deux packages est forte (par rapport au problème ou au code lui-même), plus ils doivent apparaître près dans la liste "Voir aussi". Je propose de créer deux clés de recommandation: une pour la similarité de code et une pour la similarité de problème. Les utilisateurs pourront ainsi identifier d'autres paquets potentiellement utiles beaucoup plus rapidement que s'ils devaient parcourir péniblement les dépôts et la documentation respectifs. Au lieu de lister toutes les connexions possibles entre les packages, je préfère me concentrer sur les plus importants et essayer de présenter leurs liens avec les packages plus petits (cette méthode sera également étendue aux tutoriels de mise à jour où la connexion avec un autre package doit être indiquée). Cette approche garantit que les listes "Voir aussi" seront informatives sans être des énumérations exhaustives des combinaisons de packages.