NRNB-Projekt (National Resource for Network Biology)
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-07-25 (UTC)."],[],["The technical writing project aims to enhance Cytoscape.js documentation accessibility for beginners. Key actions include migrating JSON specifications to JSDoc comments, improving existing documentation with descriptions and code examples, and creating new tutorials and videos. The project also involves developing new demos and videos to showcase Cytoscape web apps. Secondary goals include general documentation enhancements, and the project has a standard length of three months. It will be implemented in three phases.\n"]]
