Projet LLVM Compiler Infrastructure
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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:
- Infrastructure du compilateur LLVM
- Rédacteur technique:
- DR87
- Nom du projet:
- Restructuration de l'index et du guide de style de la documentation LLVM
- Durée du projet:
- Durée standard (trois mois)
Project description
Ce projet comprend les tâches suivantes:
a.) Restructuration de la page d'index de la documentation pour offrir une expérience plus conviviale. Cette tâche consiste à évaluer la page actuelle et à la restructurer en s'appuyant sur une combinaison de recherches indépendantes, d'entretiens avec des experts et de commentaires d'utilisateurs. Vous pouvez par exemple modifier les descriptions courtes, restructurer la page existante et/ou ajouter des couches (pages) supplémentaires via un modèle de divulgation progressive des informations. Cette dernière option réduirait 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 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 comprend l'évaluation du guide actuel, l'identification des lacunes par le biais de recherches indépendantes et d'entretiens avec des experts, et la mise à jour du guide en fonction des exigences convenues. Il peut s'agir, par exemple, de réorganiser la mise en page du guide, d'ajouter du contenu et d'insérer des liens vers des pages pertinentes, comme le guide du contributeur. L'objectif final est de faciliter la participation des bénévoles dès que possible.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/08 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2024/11/08 (UTC)."],[[["This project aims to improve the LLVM documentation by restructuring its index page for better user experience and updating the style guide to facilitate easier contributions."],["The project involves researching, interviewing subject matter experts, and incorporating user feedback to enhance the organization and accessibility of LLVM documentation."],["Improvements to the documentation index page may include revising descriptions, restructuring content, and implementing a progressive disclosure model for easier navigation."],["Updates to the Sphinx style guide will focus on clarity, comprehensiveness, and providing resources for open-source contributors to quickly get started."],["The project is part of Google Season of Docs and will be completed within a standard timeframe of 3 months by technical writer DR87."]]],["The project aims to improve the LLVM documentation's accessibility and usability. Key actions include restructuring the documentation index page for a better user experience, possibly adding new layers and revising descriptions. Another focus is updating the LLVM Sphinx style guide by identifying gaps, reorganizing the layout, adding new content, and including relevant links to streamline the contribution process for open-source volunteers. The project will involve research, expert interviews, and user feedback.\n"]]
