Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- National Resource for Network Biology (NRNB)
- Technical writer:
- Rahul Agrawal
- Nome progetto:
- Migliorare la documentazione di Cytoscape.Js
- Durata del progetto:
- Durata standard (3 mesi)
Project description
# Rendere la documentazione di Cytoscape.js più accessibile ai principianti.
In base alle specifiche fornite dal mentore, ho suddiviso il progetto in due categorie e vorrei implementare queste funzionalità per questo progetto. Gli annunci sono disposti in sequenza a priorità decrescente.
Funzionalità principali (antecedenti principali)
- Fase 1
Migrazione della specifica JSON esistente con riferimenti ai file Markdown nei commenti JSDoc
Perfezionare e migliorare la documentazione esistente, ad esempio scrivere una descrizione migliore o aggiungere altri snippet di codice di esempio.
- Fase 2
Scrivere nuovi tutorial e realizzare video per affrontare nuovi argomenti o trattare argomenti basilari in modi più convincenti.
- Fase 3
Realizzare nuove demo e realizzare video per dare un'idea di come siano le vera app web Cytoscape.
**Obiettivi di stretching **
Alcuni miglioramenti generali alla documentazione.