Projet NRNB (National Resource for Network Biology)
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- National Resource for Network Biology (NRNB) (en anglais)
- Rédacteur technique:
- Rahul Agrawal
- Nom du projet:
- Amélioration de la documentation Cytoscape.js
- Durée du projet:
- Durée standard (trois mois)
Project description
#
Rendre la documentation Cytoscape.js plus accessible aux débutants.
Conformément aux spécifications données par le mentor, j'ai divisé le projet en deux catégories et j'aimerais implémenter ces fonctionnalités pour ce projet. Je les ai classées par ordre de priorité décroissante.
Principales caractéristiques (priorité élevée)
- Phase 1
Migrer la spécification JSON existante avec des références à des fichiers Markdown vers les commentaires JSDoc
Affiner et améliorer la documentation existante, par exemple en rédigeant une meilleure description ou en ajoutant d'autres exemples d'extraits de code
- Phase 2
Rédiger de nouveaux tutoriels et réaliser des vidéos pour aborder de nouveaux sujets ou aborder des sujets basiques de manière plus convaincante
- Phase 3
Écrire de nouvelles démonstrations et créer des vidéos pour donner un aperçu des applications Web Cytoscape complètes.
**Objectifs supplémentaires **
Améliorations générales apportées à la documentation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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"]]