Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Infrastructure du compilateur LLVM
- Rédacteur technique:
- DR87
- Nom du projet:
- Restructurer l'index de la documentation LLVM et le guide de style de la documentation
- Durée du projet:
- Durée standard (3 mois)
Project description
Ce projet comprend les tâches suivantes:
a.) Restructurez la page d'index de la documentation pour offrir une expérience plus conviviale. Cette tâche consistera à évaluer la page actuelle et à la restructurer sur la base d'une combinaison de recherches indépendantes, d'entretiens avec des experts et des commentaires des utilisateurs. Les options possibles incluent la révision des descriptions courtes, la restructuration de la page existante et/ou l'ajout de couches supplémentaires (pages) via un modèle de divulgation d'informations progressive. Ce dernier permet de réduire le nombre de liens sur la page d'index principale afin de permettre aux utilisateurs de trouver plus facilement des informations/guides spécifiques. Par exemple, l'index peut inclure des liens vers des pages distinctes pour la conception et la présentation de LLVM, les guides de l'utilisateur, la documentation du sous-système et la documentation du processus de développement.
b.) Mise à jour du guide de style LLVM Sphinx pour les contributeurs Open Source Cette tâche comprendra l'évaluation du guide actuel, l'identification des lacunes grâce à des recherches indépendantes et des entretiens avec des experts, et la mise à jour du guide en fonction des exigences convenues. Les mises à jour peuvent inclure la réorganisation de la mise en page du guide, l'ajout de nouveaux contenus et l'insertion de liens vers des pages pertinentes, comme le guide des contributeurs. L'objectif final est d'aider les bénévoles à commencer à contribuer dès que possible.