Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
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 per i principianti.
Secondo le specifiche fornite dal mentore, ho suddiviso il progetto in due categorie e mi piacerebbe implementare queste funzionalità per questo progetto. che ho disposto in sequenza a priorità decrescente.
Funzionalità principali (prima parte)
- 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 esempi di snippet di codice
- Fase 2
Realizzare nuovi tutorial e realizzare video per trattare nuovi argomenti o trattare argomenti di base in modo più convincente.
- Fase 3
Scrivere nuove demo e realizzare video per dare un'idea di come sono le app web Cytoscape a pieno titolo.
**Obiettivi di stretching **
Alcuni miglioramenti generali alla documentazione.