Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- DVC
- Technical writer:
- imhardikj
- Nome progetto:
- Implementazione delle guide alla sezione "Istruzioni" e aggiornamento della documentazione di DVC 1.0
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Uno degli obiettivi di questo progetto è implementare la sezione "Istruzioni" che risponda in modo dettagliato alle domande comuni relative ai video in formato DVC. Il prossimo obiettivo è aggiornare la documentazione come in base all'ultima versione di DVC 1.x. Sono state apportate modifiche significative rispetto alle versioni precedenti, pertanto i documenti devono essere aggiornati all'ultima versione. Al termine, le attività successive si baseranno sulle priorità di DVC durante il periodo di scrittura.
Obiettivi del progetto:
1) Alcuni esempi per la sezione "Istruzioni" proposta: - Come "annullare" l'aggiunta di dvc (come annullare gli errori). - Come aggiungere una dipendenza mancante a una pipeline esistente. - Come utilizzare DVC quando i dati sono memorizzati su un'unità esterna (Guida alla gestione dei dati esterni).
Queste sono alcune delle idee basate sulla questione di GitHub (github.com/iterative/dvc.org/issues/899) che possono essere incluse in questa sezione. Ciò comporta anche il trasferimento di parte della documentazione esistente (ad esempio "Esecuzione di DVC su Windows") in questa sezione. Se un obiettivo di istruzioni non è adatto per questa sezione, può essere aggiornato nel riferimento al comando (o nella documentazione pertinente) con un esempio. Questa sezione può essere ampliata per includere più istruzioni ogni volta che li trovo sui canali della community.
2) L'altra parte significativa di questo progetto è l'aggiornamento della documentazione ora che è stato rilasciato DVC 1.0 (dvc.org/blog/dvc-1-0-release) e come da altri aggiornamenti rilevanti che potrebbero essere rilasciati entro settembre. I documenti (tutti i riferimenti ai comandi e così via) dovrebbero essere aggiornati in base a queste modifiche, alcune delle quali sono menzionate in questo epico numero (github.com/iterative/dvc.org/issue/1255).
3) Posso anche lavorare sull'aggiornamento di tutorial e scenari Katacoda (github.com/iterative/dvc.org/issues/670).
4) Se la sezione How-to, l'aggiornamento dei documenti DVC 1.0 e gli scenari Katacoda sono terminati prima della fine del periodo di scrittura, il resto del lavoro si baserà sulle priorità DVC durante quel periodo e su altre attività varie.
Impegno in termini di tempo:
Durante il periodo di scrittura terrò regolarmente l'università. Non ho altri impegni se non questo. Riuscirò a impegnarmi 30 ore alla settimana per l'intera durata del progetto.