Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- National Resource for Network Biology (NRNB)
- Technischer Redakteur:
- Rahul Agrawal
- Projektname:
- Verbesserte Dokumentation von Cytoscape.Js
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
# Die Cytoscape.js-Dokumentation für Einsteiger zugänglicher machen
Gemäß der vom Mentor angegebenen Spezifikation habe ich das Projekt in zwei Kategorien unterteilt und möchte diese Funktionen für dieses Projekt implementieren. Ich habe sie in absteigender Priorität angeordnet.
Wichtige Funktionen (höchste Priorität)
– Phase 1
Die vorhandene JSON-Spezifikation mit Verweisen auf Markdown-Dateien in die JSDoc-Kommentare migrieren
Die vorhandene Dokumentation optimieren und verbessern, z. B. eine bessere Beschreibung verfassen oder weitere Beispiel-Code-Snippets hinzufügen
– Phase 2
Neue Tutorials schreiben und Videos erstellen, um neue Themen zu behandeln oder grundlegende Themen auf ansprechendere Weise zu vermitteln.
– Phase 3
Wir erstellen neue Demos und Videos, um einen Eindruck davon zu vermitteln, wie vollwertige Cytoscape-Web-Apps aussehen.
**Stretch-Goals **
Einige allgemeine Verbesserungen an der Dokumentation.