Progetto LLVM Compiler Infrastructure
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per
la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Infrastruttura compilatore LLVM
- Technical Writer:
- DR87
- Nome del progetto:
- Ristruttura l'indice della documentazione LLVM e la guida di stile per la documentazione
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Questo progetto include le seguenti attività:
a.) Ristruttura la pagina dell'indice della documentazione per offrire un'esperienza più user-friendly. Questa attività prevede la valutazione della pagina attuale e la sua ristrutturazione in base a una combinazione di ricerche indipendenti, interviste a esperti del settore e feedback degli utenti. Le opzioni possibili includono la revisione delle descrizioni brevi, la ristrutturazione della pagina esistente e/o l'aggiunta di ulteriori strati (pagine) tramite un modello progressivo di divulgazione delle informazioni. Quest'ultima opzione ridurrebbe il numero di link nella pagina dell'indice principale per consentire agli utenti di trovare più facilmente informazioni/guide specifiche. Ad esempio, l'indice potrebbe includere link a pagine separate per Progettazione e panoramica di LLVM, Guide per l'utente, Documentazione del sottosistema e Documentazione del processo di sviluppo.
b.) Aggiorna la guida di stile di Sphinx di LLVM per i collaboratori open source. Questa attività includerà la valutazione della guida attuale, l'identificazione delle lacune tramite ricerche indipendenti e interviste a esperti del settore e l'aggiornamento della guida in base ai requisiti concordati. Gli aggiornamenti potrebbero includere la riorganizzazione del layout della guida, l'aggiunta di nuovi contenuti e l'inserimento di link a pagine pertinenti, ad esempio la guida per i collaboratori. L'obiettivo finale è semplificare il più possibile l'inizio del contributo dei volontari.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-11-08 UTC.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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"]]
