Pros y Contras de ReadMe

- Easy to get started

- Theme Customizations Reseña recopilada por y alojada en G2.com.

- For a docs product it has a outrageously buggy editor. Yes I understand buidling WYSIWYG editor is hard but come on, all the menu UI elements keep erractically jumping around. Cannot indent or dendent things correctly

- Terrible Keyword based search in 2024. 9/10 times search results are incorrectly ranked.

- Does not support hosting arbitrary static HTML pages - E.g. generated from Python Sphinx or Mkdocs Reseña recopilada por y alojada en G2.com.

Si estás buscando una plataforma excepcional de documentación de API, no busques más allá de Readme. Esta herramienta ha transformado la forma en que manejamos la documentación de API, ofreciendo una experiencia fluida tanto para los usuarios finales como para los desarrolladores.

La interfaz limpia de Readme y su navegación intuitiva la hicieron perfecta para nuestros clientes que buscan una integración fluida con las APIs, permitiéndoles probarla sobre la marcha y ver oportunidades.

El soporte para páginas y secciones personalizadas nos ahorró tiempo a nosotros y a nuestros clientes. Cubrimos preguntas frecuentes y nuestros webhooks, así como escribimos guías para algunos de los casos de uso más populares.

La búsqueda es excelente y ayuda a navegar por nuestra extensa API y ahorra tiempo al intentar encontrar el endpoint que necesitas. Reseña recopilada por y alojada en G2.com.

Es difícil señalar algo en particular. Diría que el principal punto de dolor sería el editor de markdown. No es un gran problema, pero es extraño verlo en una solución tan moderna. Otro inconveniente es que no hay soporte integrado para documentar webhooks. Por ahora, tenemos que usar artículos regulares y definitivamente es más difícil de mantener. Reseña recopilada por y alojada en G2.com.

Desde el momento en que comenzamos a usarlo, nos impresionó su interfaz fácil de usar y la integración perfecta con varias herramientas. Una de las características destacadas de readme son sus potentes opciones de personalización. Pudimos adaptar nuestra documentación para que coincidiera con la identidad de nuestra marca, dándole un aspecto profesional y pulido que resuena con nuestros usuarios. Además, los análisis e insights de la plataforma nos han proporcionado datos valiosos sobre el compromiso de los usuarios, lo que nos permite mejorar continuamente nuestra documentación y satisfacer eficazmente las necesidades de nuestros usuarios. Reseña recopilada por y alojada en G2.com.

Es un poco confuso cómo funcionan los planes, al principio no está muy claro si es por usuario, plan o proyecto. Reseña recopilada por y alojada en G2.com.

ReadMe allowed us within days to move our existing file-based documentation to an online, searchable and beautiful portal. The process to create new articles/guides is especially simple. The use of markdown and their building blocks meant that we could very easily copy existing collateral and just add headers/pictures as we saw fit, and it just worked out of the box. No messing around with detailed formatting or layouting and the entire site is coherent. Reseña recopilada por y alojada en G2.com.

The available landing pages didn't really suit our needs as we had a large guide with quite a few categories, so we had to create a custom HTML one -- which become a quite technical task. The final product is good, but it's something that only a subset of our editors/users can understand. Reseña recopilada por y alojada en G2.com.

La funcionalidad de carga de OAS ha optimizado y automatizado nuestro componente de actualización de especificaciones de API en nuestro proceso de lanzamiento y despliegue. Reseña recopilada por y alojada en G2.com.

No hay mucho que desagradar, supongo que la complejidad de la gestión de credenciales de API a través de inicio de sesión único es el componente más difícil de ReadMe.com. Reseña recopilada por y alojada en G2.com.

The support is wonderful and I really enjoy how easy it is to add team members. The mascot is really enjoyable and in general it gets the job done. Easy to implement. Reseña recopilada por y alojada en G2.com.

Lack of collaboration tools, no content resuse tools, hard to work with images and no options to put inline etc. They're constantly improving their API doc tools but really little focus on general user doc needs despite many recommendations over the years. Some features that are entreprise only -- seems really unfair they don't offer the ad hoc. Global search and pdf download options should not be exclusive to enterprise because the cost is so different. Reseña recopilada por y alojada en G2.com.

Readme.io proporciona un proceso de pensamiento guiado sobre cómo estructurar tus páginas, ofreciéndote una forma sencilla de construir la documentación de tu API con flexibilidad ilimitada con el editor de contenido. Las Guías y Recetas son innovadoras para las personas que consumen tu documentación. Reseña recopilada por y alojada en G2.com.

Realmente no puedo pensar en nada que no me guste de Readme.com, especialmente en comparación con otras plataformas que hemos usado antes. Reseña recopilada por y alojada en G2.com.

ReadMe toma la tarea algo desalentadora de comunicar la funcionalidad de la API y crea una forma sencilla de gestionar esa información y presentarla a los usuarios finales para que puedan actuar más rápidamente.

Como gerente de producto, trabajo con mis clientes revisando juntos la Referencia de la API y les ayudo a identificar solicitudes específicas de nuevos puntos de datos, parámetros, etc., para decidir cómo mejorarla en el futuro.

El Changelog tanto muestra el valor añadido como es un recurso confiable para cualquier cliente de larga data que necesite reaccionar a los cambios realizados. Reseña recopilada por y alojada en G2.com.

No creo que estemos utilizando todas las funciones que ofrece ReadMe, por lo que probablemente haya alguna educación o guía para el cliente que podría ser muy útil para ayudarnos a mejorar la experiencia para nuestros usuarios.

Me gustaría crear más oportunidades de educación entre las categorías y los puntos finales de la API, así como más oportunidades de navegación, ya que nuestra lista de referencias de API ha crecido bastante. Reseña recopilada por y alojada en G2.com.

Gran experiencia de usuario. La plataforma es intuitiva y fácil de usar, hay pequeños detalles como el búho que simplemente hacen que usar el producto sea más agradable. La funcionalidad de la API es excelente y es fácil enviar una solicitud de producto. También aprecio la transparencia y accesibilidad de la hoja de ruta del producto directamente desde la página de ayuda. Reseña recopilada por y alojada en G2.com.

Dado que está en markdown, hay un poco de funcionalidad limitada. Por ejemplo, si numeras listas a veces es difícil de crear si tienes una imagen u otra interrupción entre los elementos. Además, sería bueno poder incorporar archivos que no sean enlaces. Reseña recopilada por y alojada en G2.com.

Yo, como Gerente de Producto, puedo gestionar la documentación sin utilizar el tiempo de los desarrolladores. Reseña recopilada por y alojada en G2.com.

No tan intuitivo crear la página de inicio. Reseña recopilada por y alojada en G2.com.