Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- Infrastruttura per compilatore LVM
- Technical writer:
- DR87
- Nome progetto:
- Indice della documentazione relativa alla ristrutturazione e guida di stile della 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ù facile da usare. Questa attività prevede la valutazione della pagina corrente e la sua ristrutturazione in base a una combinazione di ricerche indipendenti, interviste a SME e feedback degli utenti. Le opzioni possibili includono la revisione delle descrizioni brevi, la ristrutturazione della pagina esistente e/o l'aggiunta di ulteriori livelli (pagine) tramite un modello di divulgazione delle informazioni progressiva. Il secondo ridurrebbe il numero di link nella pagina di indice principale per consentire agli utenti di individuare 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 dei sottosistemi e documentazione sul processo di sviluppo.
b.) Aggiorna la guida di stile di LLVM Sphinx per i collaboratori open source. L'attività includerà la valutazione dell'attuale guida, l'identificazione delle lacune mediante ricerche indipendenti e interviste condotte da 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, ad esempio la guida per i collaboratori. L'obiettivo finale è permettere ai volontari di iniziare a contribuire il prima possibile.