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.