Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- National Resource for Network Biology (NRNB)
- Technischer Redakteur:
- Rahul Agrawal
- Projektname:
- Cytoscape.Js-Dokumentation verbessern
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
# Die Cytoscape.js-Dokumentation für Anfänger zugänglicher machen
Gemäß den Vorgaben der beratenden Person habe ich das Projekt in zwei Kategorien unterteilt und ich werde diese Funktionen für dieses Projekt implementieren. sind absteigend nach Priorität angeordnet.
Wichtige Funktionen (oben)
- Phase 1
Migrieren der vorhandenen JSON-Spezifikation mit Verweisen auf Markdown-Dateien zu den JSDoc-Kommentaren
Verfeinern und Verbessern der vorhandenen Dokumentation, z. B. durch das Verfassen einer besseren Beschreibung oder das Hinzufügen weiterer Beispiel-Code-Snippets
- Phase 2
Neue Tutorials schreiben und Videos erstellen, um neue Themen oder grundlegende Themen auf ansprechendere Weise abzudecken.
- Phase 3
Sie schreiben neue Demos und erstellen Videos, um einen Eindruck von vollwertigen Cytoscape-Web-Apps zu vermitteln.
**Stretch-Ziele **
Einige allgemeine Verbesserungen der Dokumentation.