» Convenciones.HelpPatch
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

Convenciones.HelpPatch

English | Italian

The original english version of this page is newer and may contain information this translation does not have! Click here to view the english version.

Un HelpPatch (Patch de Ayuda) demuestra la funcionalidad de un nodo. Idealmente un usuario nuevo debería comprender de manera rápida y sencilla el sentido del nodo y un experto debería encontrar información detallada del uso del mismo.

Sugerencias de diseño

  • Comience con el patch de ayuda que se encuentra en:

\lib\nodes aTemplate () help.v4p

  • salve la plantilla renombrándola al nombre del nodo, eg: MiNodo (MyCategory) help.v4p
  • para empezar encuentre el escenario de uso más simple para el nodo, esto le proveerá al usuario nuevo un vistazo general
  • ahora explique el funcionamiento del nodo una segunda vez con un escenario más avanzado y coloque ese grafo a la derecha del construido en el paso anterior
  • encuentre escenarios adicionales si aplica y colóquelos a la derecha de los grafos existentes
  • cree IOBoxes para los pines de entrada a los cuales le haya cambiado su valor por defecto
  • no los etiquete (como si fueran pines de entrada - inputs) sino escriba un comentario al lado explicando su uso
  • en todos sus textos/comentarios por favor siga las convenciones de nombres.
  • cree una sección see also donde puede colocar nodos relacionados que el usuario debería consultar
  • agregue enlaces a información en línea (wikipedia,..) que se relacionen con el comportamiento del nodo

Contribuya

Si quiere que su patch de ayuda sea incluído en la próxima versión por favor agréguelo en el hilo del foro: missing-helppatches

anonymous user login

Shoutbox

~7d ago

yar: And now it's opertaional. It's just a concept, bugs expected

~7d ago

yar: sorry, one moment it's broken

~7d ago

yar: concept of genrative telegram bot: t.me/arktkbot

~8d ago

joreg: Reminder: Machine Learning for Interaction Designers webinar by sebescudie this Friday: https://thenodeinstitute.org/event/machine-learning-for-interaction-designers/

~9d ago

joreg: Live now: The 10th #vvvv online meetup: https://youtu.be/ShUefLRL_H0

~14d ago

karistouf: thank you @joreg