Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- OpenJS Foundation
- Technical writer:
- Leggero
- Nome progetto:
- Revisione dei documenti di Fastify
- Durata del progetto:
- Durata standard (3 mesi)
Project description
La mia attenzione sarà rivolta a due aree. Uno di questi è la creazione di una guida di stile, che comporta anche la ristrutturazione della documentazione corrente in fastify.io, in modo che i nuovi utenti possano seguirla facilmente e senza interruzioni. L'altro migliorerà la qualità dei contenuti dei contributi Fastify, in modo che i nuovi collaboratori riscontrino meno confusione e dubbi lungo il percorso. Idealmente, il risultato sarà un percorso chiaro e conciso che va dal primo contributo all'acquisizione di familiarità con il funzionamento di Fastify.
Questo progetto attraverserà le quattro fasi seguenti. Il primo è acquisire familiarità con gli strumenti completi disponibili e comprendere meglio le attuali esigenze di documentazione. L'obiettivo della seconda fase sarà strutturare, specificare e dare priorità al contesto degli obiettivi di Fastify per questa GSoD. Quindi, inizia la fase di implementazione, che prevede l'incontro con i mentori e con la community di sviluppatori di Fastify per ricevere feedback. Il passaggio finale sarà l'esame e la revisione, se necessario, e la stesura della relazione sul progetto.
Farò in modo di apportare valore al successo complessivo di questo progetto open source.