Log in
React Conferences
React Advanced 2024React Advanced 2024
ES

Diseñando Documentación Efectiva: Lecciones Aprendidas Construyendo los Docs de Redux

Mark Erikson
Mark Erikson
Replay.io
certificate
This video will go public in 6 days
Multipass and Full ticket holders have instant access to event recordings.
Please login if you have one.
Get Multipass

Register a free account to unlock access to this video today.

Rate this content
Bookmark

Acabas de terminar de construir una nueva y rápida biblioteca JS y no puedes esperar para publicarla en NPM. Pero espera un minuto, ¿qué pasa con los docs? Claro, cualquiera puede juntar un README con algunos fragmentos de código de ejemplo, pero ¿has pensado realmente en cómo diseñar los docs en sí mismos?

Únete al mantenedor de Redux, Mark Erikson, mientras observamos formas de estructurar y escribir documentación de manera efectiva para ayudar a tus usuarios a aprender y entender cómo usar tus herramientas, basándonos en años de experiencia construyendo los docs de Redux. Hablaremos sobre patrones para organizar categorías de documentación, consejos para hacer que los docs sean más fáciles de leer y entender, herramientas útiles para trabajar con el contenido de los docs, ¡y más!

This talk has been presented at React Advanced 2024, check out the latest edition of this React Conference.

documentationredux
Mark Erikson
Mark Erikson
22 min
28 Oct, 2024

Comments

Sign in or register to post your comment.
Video Summary and Transcription
Hola, soy Mark Erickson, y hoy estoy muy feliz de hablar contigo sobre el diseño de documentación efectiva, lecciones que he aprendido escribiendo los docs de Redux. Discutiremos técnicas organizativas, consejos prácticos, escritura de tutoriales y herramientas útiles de documentación. Redux ofrece tutoriales orientados al aprendizaje y guías prácticas orientadas a objetivos. Otras categorías de documentación incluyen guías de referencia, explicaciones, archivos readme, páginas de FAQ y notas de lanzamiento. Consejos para organizar y escribir documentación: considerar al lector objetivo, asumir conocimientos previos, repetir información, cubrir temas en múltiples áreas. Escribir tutoriales para bibliotecas en TypeScript presenta desafíos, pero se pueden abordar con un enfoque TypeScript-first y manteniendo los ejemplos actualizados. Los tutoriales atractivos involucran ejercicios interactivos, diagramas y formato, y deben ser revisados y mejorados en base a comentarios. En general, la documentación es valiosa y vale la pena el esfuerzo.
Available in English: Designing Effective Documentation: Lessons Learned Building the Redux Docs
Video transcription and chapters available for users with access.
Available in other languages:

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

Documentación Full Stack
JSNation 2022JSNation 2022
28 min
Documentación Full Stack
Top Content
Rich Harris
Rich Harris
Svelte Creator
The Talk discusses the shift to full-stack frameworks and the challenges of full-stack documentation. It highlights the power of interactive tutorials and the importance of user testing in software development. The Talk also introduces learn.svelte.dev, a platform for learning full-stack tools, and discusses the roadmap for SvelteKit and its documentation.
frameworkssveltedocumentation
Puerta de entrada a React: La historia de React.dev
React Summit US 2023React Summit US 2023
32 min
Puerta de entrada a React: La historia de React.dev
Rachel Nabors
Rachel Nabors
ex-React core and React Docs author
The Talk discusses the journey of improving React and React Native documentation, including the addition of interactive code sandboxes and visual content. The focus was on creating a more accessible and engaging learning experience for developers. The Talk also emphasizes the importance of building a human API through well-designed documentation. It provides tips for building effective documentation sites and highlights the benefits of contributing to open source projects. The potential impact of AI on React development is mentioned, with the recognition that human engineers are still essential.
reactdocumentationbuilders and founders
Por qué deberías usar Redux en 2024
React Summit 2024React Summit 2024
33 min
Por qué deberías usar Redux en 2024
Top Content
Mark Erikson
Mark Erikson
Replay.io
Mark Erickson explains the history, creation, evolution, and benefits of Redux. Redux was designed to make state updates and action history maintenance easy, incorporating functional programming principles. Redux Toolkit was created to simplify Redux usage. Redux is still a valid choice for its consistent pattern and separation of state from UI. The decision to use Redux depends on the specific use case and the need for centralized state management.
builders and foundersreduxreact patternsreact reduxreact state managementrtk query vs react query
TypeScript para Autores de Bibliotecas: Aprovechando el Poder de TypeScript para DX
TypeScript Congress 2022TypeScript Congress 2022
25 min
TypeScript para Autores de Bibliotecas: Aprovechando el Poder de TypeScript para DX
Daniel Roe
Daniel Roe
Daniel leads the Nuxt core team.
TypeScript for library authors offers benefits for both internal and external use, improving code quality and providing accurate understanding of libraries. Documentation and examples should be in code to provide up-to-date information. Testing types alongside unit tests ensures accurate typing. Managing changes and exposing types requires careful versioning. Deep integration of types improves usability. Using a map in TypeScript allows for simpler implementation and customization. Leveraging types in libraries can generate code based on user access. TypeScript integration with Nuxt provides support and type declarations.
typescriptnuxt.jsdocumentationdeveloper experiencetypescript libraries