Video Summary and Transcription
Rachel Neighbors habla sobre la importancia de la documentación como una segunda fuente de verdad para los desarrolladores. Comparte ideas sobre cómo mejorar la documentación de React Native, incluyendo la necesidad de material de repaso, contenido visual y ejemplos interactivos. Neighbors enfatiza el poder de la documentación para empoderar a las comunidades a construir contenido confiable y destaca la documentación de React como un ejemplo exitoso. Invita a recibir comentarios sobre la última iteración de la documentación de React.
1. Introducción a la Documentación como Fuente de Verdad
Soy Rachel Neighbors, gerente de documentación de React y React Native. Hoy hablaré sobre la documentación como tu segunda fuente de verdad y un proyecto con React Native en 2019. Tu primera fuente de verdad es tu código fuente, pero necesitarás una segunda fuente de verdad. Lo siguiente mejor es tu documentación que muestra cómo todas estas diferentes piezas funcionan juntas y cómo las personas pueden implementarlas y trabajar con ellas y construir cosas.
♪ Bueno, un poco incómodo. Estoy interrumpiendo completamente estas charlas relámpago y he interrumpido la cadena de eventos que deberían haber ocurrido. Ni siquiera sé cuánto tiempo se supone que debo hablar. Así que, si me extiendo demasiado, y lo estoy haciendo, contando demasiadas historias, puedes empezar a gritar, estamos muy aburridos, por favor, baja del escenario ahora. Lo haré. Pero trataré de no ocupar demasiado espacio hoy.
Hola. Soy Rachel Neighbors, gerente de documentación de React y React Native, y Rilay, que también es parte de la familia React. Aunque tal vez no hayas oído hablar de él, ya sabes, en GraphQL. De todos modos, eso es para una charla futura. Y hoy, he venido a hablar contigo un poco sobre algo que, bueno, un par de cosas. En primer lugar, no sé si te diste cuenta, pero tuvimos un año entero de silencio. Quiero decir, ¿qué fue eso? Mi concepto del tiempo se ha ido por completo, por eso es posible que me extienda un poco. Pero en realidad había algo que quería compartir contigo antes de que la pandemia arrasara con todas las charlas y todas las conferencias. Y es por eso que estoy aquí hoy para hablar contigo sobre la documentación como tu segunda fuente de verdad. Y hubo un pequeño proyecto en 2019 con React Native, y quiero contarte un poco sobre eso. Pero primero, la documentación, tu primera fuente de verdad es tu fuente, por supuesto. Quiero decir, tu primera fuente es tu fuente, por supuesto, por supuesto. Tu primera fuente de verdad es tu código fuente, por supuesto. Pero muy pocas bases de código se pueden leer en una hora. Recuerdo la era de jQuery, donde podías aprender JavaScript y jQuery leyendo literalmente el código fuente de jQuery, si tan solo tuviéramos tanta suerte hoy. Así que tu primera fuente de verdad puede ser tu código fuente, pero vas a necesitar una segunda fuente de verdad. Lo siguiente mejor es tu documentación que muestra cómo todas estas diferentes piezas funcionan juntas y cómo las personas pueden implementarlas y trabajar con ellas y construir cosas, etc., porque de lo contrario, no tienes tiempo para leer todo el código fuente. Esa no fue la animación correcta. Bueno, sigue adelante. Estamos volviendo al ritmo aquí. Me sorprende que los MCs todavía lo tengan, a pesar de haber estado fuera del aire durante un año. Vaya. Veamos si yo también lo tengo. Así que cuando me uní al equipo de React, tuve la tarea de mejorar la documentación de React Native, React Native y muchos otros aquí hoy y su sitio de documentación, y hacer que la documentación sea aún mejor.
2. Mejorando la Documentación de React Native
Fue un proyecto divertido. Las pruebas de usuario revelaron la necesidad de más material de repaso sobre React, así como más contenido visual y ejemplos de código interactivos. También aprendimos sobre nuestra audiencia, incluyendo su experiencia previa y la importancia de proporcionar interruptores de contexto. Actualizamos la documentación con ejemplos interactivos, involucramos a la comunidad y vimos un aumento significativo en los comentarios positivos. Una buena documentación es crucial para que los desarrolladores destaquen y enseñen a otros. React.js ha invertido en su documentación desde el primer día y ha sido fundamental para introducir a muchos desarrolladores en el desarrollo de UI.
Fue un proyecto divertido. Las pruebas de usuario, solía ser un UXer en el pasado, así que comienzo todos los proyectos que me asignan hablando con personas reales. Y estas conversaciones revelaron que necesitábamos más material de repaso sobre React. Los estudiantes querían más contenido visual. Carecíamos de contenido en profundidad sobre algunos temas especializados de alto tráfico y la documentación de componentes y API necesitaba una pequeña actualización y la gente seguía diciendo que quería más código interactivo. ¿Cuándo puedo ejecutar estos ejemplos? No voy a configurar un SDK de Android, soy un desarrollador de iOS, vamos.
También aprendimos un poco más sobre nuestra audiencia y cosas que no sabíamos antes. Por ejemplo, el 41% de los desarrolladores de React Native provienen de un entorno móvil. No tenían experiencia previa en nada antes de venir, ni siquiera en web. Fueron personas muy interesantes con las que hablar. También nos dimos cuenta de que, ya sabes, probablemente deberíamos incluir cosas como interruptores de contexto literales para hablar con personas de diferentes entornos. Antes solo decíamos, probablemente conoces React, aquí está React para tu dispositivo móvil. Lo cual estaba bien, excepto para las personas que ya estaban desarrollando para móviles y no sabían qué era React. Así que NICE se encargó de eso. Agregamos estos ejemplos interactivos realmente geniales en todas partes para que la gente pueda comenzar rápidamente. Un repaso de React para presentarlos nuevamente a React rápidamente, lo cual inspiró un proyecto futuro del que hablaremos en un momento. Y como la documentación, bueno, no se generaba automáticamente, eso significaba impulsar una campaña de toda la comunidad para actualizar la documentación, lo cual fue muy divertido porque la gente realmente quiere involucrarse en su proyecto favorito. Pero a veces estos proyectos están tan maduros que no hay más frutas bajas, pero aún hay una forma de contribuir a la documentación. Así que pusimos todo al día. Trajimos a algunos expertos como escritores invitados para solucionar los lugares donde necesitábamos profundizar, agregamos ilustraciones coloridas que resultaron ser muy populares. Y desde que reiniciamos la documentación de React Native con el nuevo contenido, vimos un aumento del 70% en las métricas positivas en general en la página. Eso fue realmente agradable. Se sintió genial.
Una mala documentación puede llevar a malas experiencias para los desarrolladores. Dificulta que los desarrolladores pasen de ser buenos a ser excelentes. Y les resulta aún más difícil enseñar a otros, difundir la palabra sobre lo que aman y lo que han descubierto. Por ejemplo, las grandes comunidades necesitan una gran documentación. El 86% de los desarrolladores de React, han aprendido utilizando la documentación en reactjs.org. Eso es algo increíble. React.js ha invertido en su documentación desde el primer día, y la gente a menudo dice que la documentación fue donde se introdujeron por primera vez en el desarrollo de UI en primer lugar.
3. El Poder de la Documentación
Con el poder de la documentación, puedes empoderar a tu comunidad para construir un ecosistema de contenido confiable. Hemos aprendido de React Native y la comunidad de React y hemos puesto en práctica esas lecciones. Echa un vistazo a la última versión de la documentación de React en beta.reactjs.org y danos tu opinión.
Entonces, pensarías, bueno, con ese tipo de poder, deberías dedicar mucho tiempo a tu documentación, invirtiendo en tu segunda fuente de verdad para empoderar a tu comunidad a construir un ecosistema completo de contenido confiable y actualizado para enseñarse mutuamente, profundizar, construir sobre lo que has creado, y confiar en que lo que están enseñando es verdadero y correcto y algo en lo que pueden basar una carrera o una comunidad o un curso de capacitación o un bootcamp.
Eso es escalar el conocimiento. Y estamos poniendo en práctica estas lecciones desde antes de la pandemia, las cosas que hemos aprendido de React Native y de la comunidad de React y lo que funcionó con la documentación de React.js, las hemos estado poniendo en práctica durante el pasado, bueno, desde los tiempos anteriores. Y hoy, queremos compartir contigo un pequeño adelanto de en qué hemos estado trabajando. Esto es super, super beta, pero si vas a beta.reactjs.org, puedes ver la última versión de la documentación de React. Nos encantaría saber qué opinas al respecto. Hay lugares en el sitio donde puedes dejar comentarios, y esperamos escuchar de ti. Si te gusta, genial. Si no te gusta, dinos por qué. Estamos esperando tus comentarios. Gracias y bienvenido de nuevo.
Comments