Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- National Resource for Network Biology (NRNB)
- Technischer Redakteur:
- Rahul Agrawal
- Projektname:
- Verbesserung der Cytoscape.Js-Dokumentation
- Projektdauer:
- Standarddauer (3 Monate)
Projektbeschreibung
# Die Cytoscape.js-Dokumentation für Anfänger zugänglicher machen
Gemäß den Vorgaben des Mentors habe ich das Projekt in zwei Kategorien unterteilt und ich werde diese Funktionen für dieses Projekt implementieren. die mit absteigender Priorität angeordnet sind.
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
Das Verfassen neuer Tutorials und das Erstellen von Videos, um neue Themen oder grundlegende Themen auf überzeugendere Weise abzuhandeln.
- Phase 3
Neue Demos schreiben und Videos erstellen, um einen Eindruck von vollwertigen Cytoscape-Web-Apps zu vermitteln
**Stretch-Ziele **
Einige allgemeine Verbesserungen der Dokumentation.