Presentando React View

Rate this content
Bookmark

¡Así que has construido una biblioteca de componentes! ¡Felicidades! Estoy seguro de que es increíble, pero ¿has puesto el mismo esfuerzo en su documentación? Las bibliotecas de componentes tienden a tener APIs gigantes, docenas de componentes, cientos de props y miles de combinaciones. Eso es mucha información para desempacar.


Podríamos hacer la documentación muy extensa o... súper interactiva. Combinamos vistas previas de componentes, documentación de API, edición de props y edición de código en una experiencia única y fluida. Puedes explorar rápidamente varias configuraciones de cada componente mientras ves cómo se escribe el código.


Esta charla te mostrará cómo aprovechar herramientas y conceptos comunes como Prettier, babel y transformaciones AST para construir una documentación que literalmente puede trabajar para ti.

30 min
17 Jun, 2021

Video Summary and Transcription

ReactJS es un framework basado en JavaScript que enfatiza la importancia de construir una documentación increíble para reducir preguntas. El ponente discute el sitio web personalizado construido usando Next.js y MDX, y los desafíos de lidiar con JSX y el proceso de compilación. La charla también aborda la interacción con NAPs, la extracción de información del código utilizando AST y los beneficios de usar Babel y AST Explorer. Se explica el proceso de construcción y generación de código con AST, junto con la importancia de la documentación y ReactVue. El ponente también proporciona información sobre cómo comenzar con la documentación, construir documentación personalizada y mantenerla sincronizada con el código.

Available in English

1. Introducción a ReactJS y Documentación

Short description:

ReactJS es un lenguaje de JavaScript que utiliza tanto Python como Python. Es un lenguaje basado en JavaScript que se puede utilizar para escribir JavaScript para cualquier lenguaje. Es un marco que te permite usar ReactJS de muchas formas. Hoy, hablaré sobre la documentación y la importancia de construir una documentación increíble para reducir la cantidad de preguntas en nuestros chats y problemas de GitHub.

¿Cómo funciona ReactJS? ReactJS es un lenguaje de JavaScript que utiliza tanto Python como Python. Es un lenguaje basado en JavaScript que se puede utilizar para escribir JavaScript para cualquier lenguaje. Es un marco que te permite escribir JavaScript en un marco existente. ReactJS te permite usar ReactJS de muchas formas.

¿Cómo funciona ReactJS? Hola, mi nombre es Wojciech Miksiu y hoy hablaré sobre la documentación. Mi trabajo consiste en construir una biblioteca de componentes de React llamada baseweb y otras herramientas web en Uber. Baseweb es una implementación de nuestro sistema de diseño y lo utilizamos en todas las aplicaciones. Así que hablemos de la documentación. Es algo que la mayoría de nosotros usamos todos los días y es absolutamente esencial. Todos los días estamos sentados en nuestros escritorios tratando de aprender cosas leyendo y solo a veces nos detenemos a escribir unas pocas líneas de código. Y hay muchas fuentes diferentes de documentación. Tenemos libros, MDN, Stack Overflow, comentarios en el código o simplemente buscamos cosas al azar hasta que nos rendimos y preguntamos a nuestros colegas en Slack.

Pero, ¿cuál es mi verdadera motivación para hablar de esto hoy? Me uní a la empresa hace dos años y esta fue la propuesta que me hicieron. Únete a nosotros. Estarás construyendo componentes de React. Eso sonaba increíble y me convencieron de inmediato. Sin embargo, la realidad del trabajo orientado a la plataforma es ligeramente diferente. Se parece más a este gráfico. Y francamente, es algo bueno. Si nadie usa tus cosas, significa que si nadie te hace preguntas, significa que nadie usa tus cosas y sería terrible. Así que se podría decir que mi equipo se convirtió en víctima de su propio éxito. Cuando comenzamos BaseWeb hace dos años, apenas se usaba y teníamos mucho tiempo para simplemente escribir código, pero luego el uso aumentó. Ahora hay más de 600 aplicaciones solo en Uber y eso se traduce en casi mil desarrolladores. Además, nuestra biblioteca tiene una gran superficie de API. Hay más de 60 componentes, cientos de preparativos y prácticamente infinitas posibilidades. También tenemos muchos colaboradores y usuarios externos. Por lo tanto, naturalmente, pasamos mucho tiempo brindando soporte. La pregunta era, ¿podemos recuperar algo de este tiempo? Creo firmemente que si construimos una documentación increíble, podemos reducir significativamente la cantidad de preguntas en nuestros chats y problemas de GitHub. Además, realizamos encuestas frecuentes. Y la documentación siempre es el tema más mencionado.

2. Importance of Documentation and Custom Website

Short description:

Mi equipo invierte tiempo en experimentar con diferentes tipos de documentación. Te mostraré versiones antiguas de nuestro sitio web de documentación y explicaré por qué no era lo suficientemente bueno. Lanzamos nuestro propio sitio web personalizado basado en Next.js y MDX. Algunos tipos estáticos son demasiado complicados y no legibles para los humanos. Agregar más ejemplos puede resultar abrumador. Creamos un espacio de juego para nuestros componentes para mostrarlos y explorarlos.

Entonces, mi equipo ahora invierte mucho tiempo en experimentar con diferentes tipos de documentación. Espero que hasta ahora haya dejado claro por qué la documentación es tan importante. Aquí está la agenda de la charla. Te mostraré algunas versiones antiguas de nuestro sitio web de documentación y explicaré por qué no era lo suficientemente bueno. Luego, lo que construimos con React y usamos hoy. También voy a echar un vistazo bajo el capó y mostrarte algunos conceptos y código relacionados con los compiladores y los árboles de sintaxis abstracta. Y finalmente, la conclusión. Esta es la versión más antigua de nuestra documentación, es simplemente storybook. Es una solución lista para usar que usamos para desarrollar nuestros componentes, pero también para documentarlos. Puedes ver que es simplemente un montón de ejemplos, y en la parte inferior puedes ver el archivo de lectura donde documentamos nuestras propiedades. Pero a medida que crecimos en número de componentes, queríamos tener algo más estructurado y personalizado. Así que lanzamos nuestro propio sitio web personalizado basado en Next.js y MDX. Ahora los componentes están en diferentes categorías, la página en sí está más estructurada. Cada ejemplo tiene su propio código fuente que se escribe manualmente, y en la parte inferior tenemos una documentación de propiedades generada en función de los tipos estáticos. Y esto funciona bastante bien, hasta que deja de hacerlo. Algunos tipos estáticos son demasiado complicados y no son realmente legibles para los humanos. Además, muchas propiedades están destinadas a ser utilizadas solo internamente, cuando se componen con otros componentes. Pero ahora las exponemos en la API pública, y eso solo confunde. Intentamos ajustar esto muchas, muchas veces, pero nunca fue confiable y no fue suficiente como fuente principal de documentación. Los desarrolladores siempre pueden darse cuenta cuando algo está generado automáticamente, y no les encantará precisamente. ¿Por qué deberían hacer un esfuerzo adicional para leerlo, si tú no hiciste ningún esfuerzo para crearlo? Entonces, ¿qué tal agregar muchos ejemplos? ¿A quién no le gustan más ejemplos? Este es nuestro componente técnico. Es bastante simple, y sin embargo, hay 384 permutaciones diferentes de él. ¿Podemos mostrar 384 ejemplos en una sola página? Claro. ¿Será abrumador? Absolutamente. Y lo mismo ocurre con otros componentes. Si hay un número limitado de ejemplos que podemos presentar para no abrumar a nuestros usuarios, ¿qué más podemos hacer? Bueno, vamos a desactivar y explorar estas permutaciones. Permíteme mostrarte lo que construimos.

Entonces, esto es como un espacio de juego que construimos para nuestros componentes. En primer lugar, quieres mostrar el propio componente. La segunda parte más importante es probablemente el propio código fuente.

3. Editing Source Code and JSX Compilation

Short description:

Puedes editar el código fuente en tiempo real y se mostrarán los errores de sintaxis. Al pasar el cursor sobre los componentes, se muestran sus tipos estáticos. Se pueden crear funciones de JavaScript a partir de cadenas utilizando una API útil. Sin embargo, al tratar con JSX, se necesita un compilador para transformarlo en React.createElement. Babel se puede utilizar en el navegador con este propósito. El componente resultante y el código fuente interactivo se pueden formatear, copiar y compartir de manera conveniente.

Lo bueno del código fuente es que puedes editarlo en tiempo real. Y a medida que escribes, el componente cambia. Si cometes un error de sintaxis, simplemente te decimos qué está mal. También agregamos esta función donde puedes pasar el cursor sobre diferentes componentes y ver sus tipos estáticos. Esta es una característica bastante común en muchas documentaciones.

¿Alguna vez te has preguntado cómo funciona esto en tu navegador? Hay una API útil para crear funciones de JavaScript a partir de cadenas. El primer argumento son los parámetros de la nueva función seguidos del cuerpo. A diferencia de una función val, esto se ejecuta solo con un alcance global. Entonces, todo lo que quieras pasar y usar en esta función, debes pasarlo como argumento.

Ahora podemos ejecutar dinámicamente cualquier JavaScript desde una cadena. Pero, ¿qué pasa si no tratamos solo con JavaScript plano? En realidad, casi nunca lo hacemos. Todos nuestros componentes usan JSX. Probablemente hayas visto qué sucede si intentas ejecutar JSX en tu navegador. Obtienes un error de sintaxis sobre un token inesperado. Realmente no podemos pedirle a las personas que escriban React, createElement en lugar de JSX. Entonces, necesitamos introducir un paso adicional, un proceso adicional. Necesitamos agregar un compilador. ¿Recuerdas a Babel? La mayoría de nosotros lo usamos cuando necesitamos compilar nuestras aplicaciones. Pero también podemos usarlo en nuestro navegador para compilar nuestro JSX en React, createElement. Usamos la función de transformación de Babel core. Cargamos el preset de React. Le pasamos nuestro componente. Y devuelve la llamada a React createElement. Así que esto funciona bastante bien. Ahora tenemos el componente. Tenemos el código fuente interactivo. Permíteme también editar algunas funciones convenientes. Por ejemplo, a los desarrolladores les gusta formatear su código para que sea más legible antes de copiarlo y pegarlo. Puedes copiar el código en el portapapeles. Puedes obtener un enlace permanente.

4. Interacting with NAPs and Extracting Information

Short description:

Puedes interactuar con los NAPs, que representan cada prop del componente. El estado se sincroniza en todas las partes, lo que te permite copiar y pegar el componente exacto en su estado actual. Además, aún puedes cambiar el código fuente y ver las actualizaciones reflejadas en el estado. Para describir las propiedades del botón, se utiliza un formato de configuración simple. La extracción de información del código se realiza convirtiéndolo en un árbol de sintaxis abstracta, lo que proporciona un enfoque más poderoso.

Puedes volver al estado inicial. Y también puedes iniciar CodeSandbox y hacer ediciones más serias, si lo deseas. Esto es genial, pero a veces ni siquiera sabes qué otras props puedes usar para este componente. Entonces, necesitas algún tipo de API de props o documentación de props.

Agregamos esta parte adicional que llamamos NAPs. Cada prop está representada por un solo NAP, y también puedes interactuar con él. A medida que cambio este valor, puedes ver que se actualiza el componente en sí. Pero lo más importante, también se actualiza el código fuente. Este estado se sincroniza en todas estas tres partes. Y aún mejor, por ejemplo, si cambio este tipo a secundario, puedes ver que incluso cambia la importación. Entonces, esto es algo que siempre puedes copiar y pegar en tu aplicación y obtener este componente exacto en este estado exacto.

No solo puedo interactuar con estos NAPs, también puedo seguir cambiando el código fuente en sí. Y puedes ver que, nuevamente, se actualiza el estado aquí, por lo que esta casilla de verificación ahora está marcada y el componente está en estado de carga. ¿Cómo funciona esto? En primer lugar, debemos describir de alguna manera qué propiedades tiene nuestro botón. Podemos renderizar los NAPs. Hemos creado un formato de configuración simple. Aquí tienes un ejemplo. Para cada prop, puedes establecer el nombre, el tipo y la descripción.

Y, cuando actualizamos el código, ahora necesitamos extraer algunas partes de información de él. Necesitamos los nombres y valores de las props para poder mostrarlos en nuestros NAPs. La primera solución rápida sería usar una expresión regular, como aquí. Aquí estamos buscando un elemento JSX y obteniendo las partes con props e hijos. Funciona, pero es extremadamente frágil. ¿Qué pasa si tenemos varios componentes? ¿Qué pasa si están anidados? ¿Cómo diferenciarlos? Ahora el código es solo una cadena larga y tonta. No tenemos una comprensión más profunda de lo que realmente representa. Entonces no podemos hacer mucho al respecto. Necesitamos un enfoque completamente diferente y más poderoso. Necesitamos convertir nuestro código en un árbol. El árbol de sintaxis abstracta. Afortunadamente, ya tenemos una herramienta para eso en nuestro proyecto.

5. Understanding Babel and AST Explorer

Short description:

Babel crea un AST a partir del código que le pasas. AST Explorer es una herramienta útil para inspeccionar ASTs. Ayuda a identificar las diferentes partes del código y sus nodos correspondientes, como identificadores JSX y literales de cadena.

Es Babel. Para que Babel haga algo con tu código, también necesita esta comprensión más profunda de su significado. Así que siempre comienza creando un AST a partir del código que le pasas. Puedes inspeccionar los AST en esta herramienta muy útil llamada AST Explorer. Aquí está nuestro botón. Estamos usando Babel Parser. Y en el lado derecho, puedes ver las tres representaciones de nuestro código. Ahora, si paso el cursor sobre diferentes partes de nuestro código, puedes ver qué nodo se está resaltando. Por ejemplo, este botón ahora corresponde a este identificador JSX. Si paso sobre el tipo, puedes ver que es solo un atributo JSX y el primario es un literal de cadena. Ahora sé exactamente qué parte de este código es cada una y puedo asegurarme de obtener los valores que necesito obtener.

6. Building and Generating Code with AST

Short description:

Aquí está la implementación: analiza tu código con el analizador de Babel para generar la estructura del árbol. Utiliza la función traverse para encontrar los atributos o props de gsx y guardar sus nombres y valores. También podemos revertir este proceso cambiando los props y actualizando el código. Sin embargo, unir cadenas puede llevar a complicaciones y errores de sintaxis. Construir un árbol de sintaxis abstracta (AST) desde cero proporciona un enfoque más confiable. Una vez que tenemos el AST, podemos utilizar el generador de Babel para convertirlo en código. Para que el código sea más legible, podemos utilizar Prettier, una herramienta popular que utiliza la misma representación AST que Babel.

Entonces aquí está la implementación. Primero, utilizas la función parse de Babel parser y le das tu código, y esto genera la estructura del árbol que viste. Luego utilizamos la función traverse para recorrer este árbol y buscar todos los atributos o props de gsx. Una vez que obtenemos este tipo de nodo, simplemente guardamos el nombre y el valor. Esta es una forma muy sencilla de obtener todos los nombres y valores de los props de nuestro componente.

También demostré que podemos hacerlo al revés. Pude cambiar estos snaps y en realidad estaba actualizando este código. Y por cierto, nunca hemos escrito una sola línea de este código en nuestros ejemplos. Todo esto se genera solo en función de la configuración de los props y el estado de este playground. ¿Cómo funciona este proceso al revés? ¿Cómo generamos realmente un código? Como puedes imaginar, hay algún tipo de estado donde tienes la lista de los nombres y sus valores de los props, y sabes cuál es el nombre del componente. Nuevamente, podríamos intentar algo simple y simplemente unir un montón de cadenas juntas, y esto nos dará el fragmento final y funcionará. Pero se complica bastante rápido con todas las excepciones y casos diferentes. Y también es una forma muy fácil de producir un código que no funciona y tiene errores de sintaxis. Ya aprendimos una lección similar con las expresiones regulares. Entonces, nuevamente, necesitamos un enfoque más confiable.

Ya mencioné los árboles anteriormente y resulta que también puedes construirlos desde cero. Este es un ejemplo simplificado de una función que crea un AST de un elemento JSX. Podemos componer nodos juntos para construir nuestro propio árbol desde cero. Dado que todas estas funciones son de tipo estático, si olvidamos pasar algún valor, obtendremos un error. Y ahora podemos estar seguros de que sea cual sea el script final, funcionará. Por supuesto, ahora tenemos el AST, pero todavía necesitamos convertirlo en código. Una vez que tenemos el AST, podemos utilizar la función generate de Babel generator. Esto simplemente convierte el AST en código. Pero hay un problema. Esto solo dará como resultado una sola línea de código, que no es muy legible. Así que vamos a ser más elegantes y podemos utilizar otra herramienta popular llamada Prettier. Y Prettier utiliza la misma representación AST que Babel para el código. Así que podemos usar Prettier para imprimir un fragmento de código mucho más bonito. Hay muchas otras características de este playground que no tengo tiempo de mostrarte.

7. Final Thoughts on Documentation and ReactVue

Short description:

No todos los componentes son tan simples como un botón. Admitimos varios escenarios complejos, como el uso de estados locales, la anidación de múltiples componentes y la creación de prototipos personalizados. React View es una biblioteca de código abierto con su propia documentación interactiva. La documentación es inmensamente importante tanto para los clientes como para los desarrolladores. Los árboles de sintaxis abstracta y herramientas como Babel y Prettier pueden mejorar enormemente la documentación. Echa un vistazo a ReactVue, un proyecto de código abierto que impulsa nuestros ejemplos y documentación. Tener una especificación de prop para cada componente también se puede traducir en fragmentos de código de VS Code, lo que facilita a los desarrolladores producir nuevo código.

Por ejemplo, no todos los componentes son tan simples como un botón. A veces necesitas incluir... A veces necesitas usar estados locales para hacer que tus ejemplos sean realistas. Nosotros lo admitimos. A veces necesitas anidar múltiples componentes. Nosotros lo admitimos. Incluso puedes querer construir un prototipo personalizado y un NAP personalizado. Nosotros también lo admitimos. Todo esto está preparado en esta biblioteca llamada React View. Es de código abierto. Y tiene su propia documentación interactiva. Así que, por favor, échale un vistazo.

Y aquí van algunas reflexiones finales. En primer lugar, la documentación es inmensamente importante y una parte crítica de cualquier cosa que envíes. Ayuda a tus clientes a usar tu producto. Pero también hazlo por tus propias razones egoístas. Puedes ahorrarte mucho tiempo al no responder preguntas que pueden ser respondidas por una documentación de calidad.

En segundo lugar, ¿cómo podemos mejorar mucho la documentación? Obtén tus superpoderes con los árboles de sintaxis abstracta y herramientas como Babel y Prettier. Ya los usamos para construir nuestras aplicaciones, pero también podemos usarlos para escribir algunas partes aburridas de nuestro código y construir una documentación mucho mejor.

Y finalmente, para comenzar, echa un vistazo a ReactVue. Es de código abierto y alimenta todos los ejemplos de mi charla y nuestra documentación. Y hay una cosa más, encontramos otro uso para tener una especificación de prop para cada componente. Lo tradujimos en fragmentos de código de VS Code. Es una excelente función para usuarios avanzados. Muchas veces, tus desarrolladores ni siquiera necesitan leer la documentación para producir nuevo código. ¿Y qué hay mejor que eso? Si quieres mantenerte actualizado, aquí está mi Twitter. Y gracias por ver. Charlas fantásticas hoy, y la tuya definitivamente se suma a la larga lista de grandes charlas que hemos visto. Y de nuevo, solo... la cita. Ah, tan buena.

8. Getting Started with Documentation and ReactView

Short description:

La documentación es importante. Comienza incrementalmente con Storybook para desarrollar componentes y utiliza sus complementos para la documentación. Si necesitas más, prueba una solución personalizada como Gatsby y MDX. ReactView se puede utilizar junto con Storybook como complemento. Genera código fuente y admite cualquier componente de React. El proceso para nuestra empresa implicó construir la biblioteca de componentes utilizando Storybooks.

Esto es como, sí, la documentación es importante, gente. Una pregunta que me estaba haciendo cuando vi esto, y recordé cómo empecé con la documentación en el pasado. ¿Cómo dirías... cuál es una buena manera para que las personas comiencen a crear documentación? ¿Cuál es el buen punto de partida? Sí, para nosotros también fue un proceso, ¿verdad? Nos llevó un tiempo construir todo el sistema, así que diría que comiences incrementalmente. Creo que Storybook es una gran opción, porque puedes usarlo para desarrollar tus componentes, y tiene algunos complementos realmente geniales, así que también puedes documentarlos. Después de un tiempo, cuando eso no es suficiente, o sientes que necesitas algo más, tal vez deberías usar una solución personalizada. Tuvimos una charla realmente buena sobre Gatsby y MDX. Realmente, realmente me gusta MDX. También lo usamos. Usamos Next.js, es similar. Pero sí, simplemente comienza incrementalmente. Storybook es una excelente manera de comenzar rápidamente. MDX es increíble después.

De hecho, eso me lleva a una pregunta de Forzu del canal, que es, si tengo una biblioteca de muestra de Storybook, ¿debería probar ReactView para la documentación? Nuestro sistema de diseño está bastante integrado con NX y Storybook. ¿Es un complemento o una alternativa a Storybook usar ReactView? También puedes usarlo con Storybook. ReactView es solo un componente de React, por lo que se puede usar en Storybook. En cierto modo, es similar. En Storybook, también tienes estos mapas donde puedes cambiar valores y ver diferentes variantes de tus componentes. ReactView va un paso más allá. Genera el código fuente por ti. Entonces, sí, puedes usarlo al mismo tiempo. Storybook admite cualquier cosa. Simplemente puedes poner cualquier componente de React allí. ReactView es solo otro componente de React, por lo que definitivamente puedes usarlo juntos. Eso es agradable. Eso es bastante genial.

Y mencionaste, volviendo a la pregunta original sobre cómo comenzar, mencionaste que fue un proceso para tu empresa. Entonces, ¿qué dirías que fue el proceso? ¿Cuáles fueron los pasos que tuvieron que seguir? Además de elegir tu tecnología y una solución para producir la documentación, ¿cómo se veía más o menos todo el proceso? Correcto. Primero comenzamos construyendo toda la biblioteca de componentes. Esa era la prioridad, simplemente sacar todos los componentes. Por eso usamos Storybooks.

9. Building Custom Documentation and Search

Short description:

No dedicamos mucho tiempo a construir documentación personalizada. Escuchamos las dificultades de los usuarios e intentamos responder a sus preguntas. Para mejorar la documentación, solicita comentarios a los usuarios y realiza encuestas. La construcción de una documentación personalizada permite abordar preguntas auxiliares y frecuentes. Una buena función de búsqueda es esencial y soluciones de código abierto como Algolia pueden ayudar. Elasticsearch es otra opción.

No dedicamos mucho tiempo a construir documentación personalizada. Pero también tenemos este canal de soporte y estábamos escuchando a las personas. Tienen muchas dificultades para usar nuestros componentes, y siempre intentábamos responder a estas preguntas. Y luego vemos que las personas hacen las mismas preguntas. Pensamos, ¿cómo podríamos reunir estas preguntas y resolverlas en nuestra documentación para que las personas dejen de preguntarnos lo mismo una y otra vez.

Entonces, intenta preguntar a las personas que usan tu documentación, tu proyecto, qué opinan sobre tu documentación, qué falta. Definitivamente te lo dirán porque pasan mucho tiempo buscando respuestas. Así que es como este feedback constante de tus usuarios que realmente mejora tu documentación. Deberías preguntarles con frecuencia, tal vez hacer una encuesta. Eso es realmente genial. También me preguntaba sobre esto. Entonces construiste una biblioteca de componentes y estoy bastante seguro de que tienes muchos componentes, ¿verdad? Y no solo eso. Quiero decir, los componentes son una cosa sobre la que las personas pueden tener preguntas. Pero puede haber preguntas auxiliares o preguntas frecuentes que te hacen que no están necesariamente directamente relacionadas con un componente, sino como la interacción de componentes o algo así. ¿Cómo puedes asegurarte de que los usuarios encuentren las respuestas a sus preguntas dentro de tu extensa documentación?

Sí, esa es una gran pregunta. Esa también fue una de las razones por las que decidimos construir una documentación personalizada, no solo usando storybook. Porque no es suficiente solo documentar componentes, sino que también quieres tener la historia de todo el sistema. Pero que también cubra otras preguntas importantes. Entonces, otra cosa para facilitar esto es tener una buena búsqueda en tu documentación. Tener una buena búsqueda de texto completo es realmente útil. Y hay algunas soluciones gratuitas de código abierto como Algolia, que son realmente buenas y que construyen el índice por ti. Genial. Sí. Eso es bastante genial. Creo que también hay, cómo se llama, Solar y, ah, hay otro que no puedo recordar, Elasticsearch. No, eso es algo diferente. Elasticsearch es una búsqueda de texto completo, sí. Sí, eso también funcionaría. En realidad, no he probado mucho Algolia. También, disculpa.

10. Starting Documentation and Keeping it in Sync

Short description:

Cuándo comenzar a escribir documentación depende del proyecto. Para nuevos prototipos, es mejor evitar la documentación ya que las APIs pueden cambiar con frecuencia. Sin embargo, para proyectos a largo plazo, es más fácil comenzar a documentar desde el principio. Evita depender demasiado de la generación automática y concéntrate en crear documentación legible para los humanos. Mantén la documentación y el código en el mismo lugar para asegurarte de que estén sincronizados.

También, otra cosa que he visto con empresas que finalmente invirtieron en documentación, algunas de ellas lo hicieron demasiado tarde. Si tienes una gran cantidad de contenido para cubrir, crear documentación muy tarde en el proceso es realmente difícil de hacer bien. ¿Dirías que se debe escribir documentación desde el principio, desde el comienzo de un proyecto, o depende de cuándo comenzar a escribir documentación?

Esa es también una buena pregunta. Entonces, si estás construyendo algo completamente nuevo y solo estás haciendo prototipos, puede que no sea lo mejor comenzar con la documentación. Porque probablemente cambiarás las APIs mucho y estarás perdiendo mucho tiempo. Por otro lado, si sabes que lo que estás construyendo es a largo plazo, podría ser mucho más fácil hacerlo al mismo tiempo, como comenzar a documentar todo al mismo tiempo. Porque, ya sabes, cuando quieres lanzar un proyecto, no tienes documentación. Es realmente molesto. Como ahora, tengo que dejar de hacer cualquier cosa y durante las próximas dos semanas, solo voy a escribir un gran bloque de texto. Así que probablemente sea más fácil hacerlo al mismo tiempo, a menos que estés haciendo prototipos de algo nuevo y no estés seguro todavía. Es una especie de compromiso.

Eso es un buen punto. Sí, tiene sentido. Siguiendo esa pregunta, Fauzul pregunta si tenemos recomendaciones como las que hemos visto en la última charla de MDX. Probablemente. Me gustaría mostrar casos de uso como habitaciones de IKEA para mis componentes en la documentación. También, gran charla, dice él. Gracias.

De acuerdo, entonces una recomendación es no depender demasiado de la generación automática. Es muy tentador usar alguna herramienta que extraiga tipos estáticos de tus componentes y simplemente genere toda esta documentación de la API. No estoy diciendo que la documentación de la API no sea útil, pero las personas ya están usando TypeScript, por lo que pueden ver qué APIs pueden usar. Probablemente estén más interesados en casos de uso más profundos, por lo que siempre debes intentar crear tu documentación a medida para escenarios reales. Así que simplemente no confíes en la generación automática. Intenta realmente escribir documentación legible para los humanos, algo que te gustaría ver como desarrollador. Esa sería mi recomendación, y al mismo tiempo, también lo que debes hacer. Dedica tiempo y hazlo agradable, legible para los humanos... incluso divertido, ¿verdad? Queremos divertirnos al leer la documentación.

También, cuando se trata de ser un desarrollador y escribir documentación, otra cosa que noto y también es una mala práctica... Creo que lo único peor que la documentación es la documentación desactualizada. ¿Cómo lidias con el cambio de código y la documentación que no se actualiza? Creo que lo más importante es mantener la documentación y el código en el mismo repositorio, en el mismo lugar. Y simplemente, ya sabes, reutilizar cosas. Si cambio un componente, en realidad va a romper los ejemplos en mi documentación, así que también tengo que arreglar eso. Y también, ya sabes, cualquier función que agregue a cualquier componente, al mismo tiempo también tengo que crear documentación para ello. Entonces, si mantienes estas cosas juntas en el mismo lugar, estando vinculadas, siempre te verás obligado a mantenerlas sincronizadas, lo que realmente ayuda. Esa es una forma genial de abordar esto. Increíble. Wojtek, creo que fue una charla increíble y estoy realmente agradecido de que estuvieras aquí para responder todas tus preguntas, todas las preguntas que hay ahí fuera y también mis preguntas.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

React Advanced Conference 2022React Advanced Conference 2022
25 min
A Guide to React Rendering Behavior
Top Content
React is a library for "rendering" UI from components, but many users find themselves confused about how React rendering actually works. What do terms like "rendering", "reconciliation", "Fibers", and "committing" actually mean? When do renders happen? How does Context affect rendering, and how do libraries like Redux cause updates? In this talk, we'll clear up the confusion and provide a solid foundation for understanding when, why, and how React renders. We'll look at: - What "rendering" actually is - How React queues renders and the standard rendering behavior - How keys and component types are used in rendering - Techniques for optimizing render performance - How context usage affects rendering behavior| - How external libraries tie into React rendering
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Top Content
Remix is a new web framework from the creators of React Router that helps you build better, faster websites through a solid understanding of web fundamentals. Remix takes care of the heavy lifting like server rendering, code splitting, prefetching, and navigation and leaves you with the fun part: building something awesome!
React Advanced Conference 2023React Advanced Conference 2023
33 min
React Compiler - Understanding Idiomatic React (React Forget)
React provides a contract to developers- uphold certain rules, and React can efficiently and correctly update the UI. In this talk we'll explore these rules in depth, understanding the reasoning behind them and how they unlock new directions such as automatic memoization. 
React Advanced Conference 2022React Advanced Conference 2022
30 min
Using useEffect Effectively
Top Content
Can useEffect affect your codebase negatively? From fetching data to fighting with imperative APIs, side effects are one of the biggest sources of frustration in web app development. And let’s be honest, putting everything in useEffect hooks doesn’t help much. In this talk, we'll demystify the useEffect hook and get a better understanding of when (and when not) to use it, as well as discover how declarative effects can make effect management more maintainable in even the most complex React apps.
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Top Content
Concurrent React and Server Components are changing the way we think about routing, rendering, and fetching in web applications. Next.js recently shared part of its vision to help developers adopt these new React features and take advantage of the benefits they unlock.In this talk, we’ll explore the past, present and future of routing in front-end applications and discuss how new features in React and Next.js can help us architect more performant and feature-rich applications.
React Advanced Conference 2021React Advanced Conference 2021
47 min
Design Systems: Walking the Line Between Flexibility and Consistency
Top Content
Design systems aim to bring consistency to a brand's design and make the UI development productive. Component libraries with well-thought API can make this a breeze. But, sometimes an API choice can accidentally overstep and slow the team down! There's a balance there... somewhere. Let's explore some of the problems and possible creative solutions.

Workshops on related topic

React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Featured WorkshopFree
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
React Advanced Conference 2021React Advanced Conference 2021
132 min
Concurrent Rendering Adventures in React 18
Top Content
Featured WorkshopFree
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Top Content
Featured Workshop
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React Advanced Conference 2021React Advanced Conference 2021
174 min
React, TypeScript, and TDD
Top Content
Featured WorkshopFree
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
React Advanced Conference 2021React Advanced Conference 2021
145 min
Web3 Workshop - Building Your First Dapp
Top Content
Featured WorkshopFree
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Featured Workshop
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn