Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Infrastruttura compilatore LVM
- Technical writer:
- DR87
- Nome progetto:
- Ristruttura l'indice della documentazione di LLVM e la guida di stile della documentazione
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Questo progetto include le seguenti attività:
a.) Riorganizza la pagina dell'indice della documentazione per offrire un'esperienza più semplice. Questa attività comporterà la valutazione della pagina corrente e la sua ristrutturazione in base a una combinazione di ricerche indipendenti, interviste con SME e feedback degli utenti. Le possibili opzioni includono la revisione delle descrizioni brevi, la ristrutturazione della pagina esistente e/o l'aggiunta di altri livelli (pagine) tramite un modello di divulgazione delle informazioni progressiva. Quest'ultimo ridurrebbe il numero di link nella pagina di indice principale per consentire agli utenti di trovare più facilmente informazioni/guide specifiche. Ad esempio, l'indice potrebbe includere link a pagine separate per la progettazione e la panoramica di LLVM, le guide dell'utente, la documentazione del sottosistema e la documentazione del processo di sviluppo.
b.) Aggiorna la guida di stile su LLVM Sphinx per i collaboratori open source. L'attività includerà la valutazione della guida attuale, l'identificazione delle lacune attraverso la ricerca indipendente e le interviste con le PMI 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, come la guida per i collaboratori. L'obiettivo finale è permettere ai volontari di iniziare a contribuire il prima possibile.