Pros y Contras de ReadMe

La capacidad de documentar las APIs a través de las interfaces gráficas, la última actualización ha mejorado para enriquecer aún más la documentación. Reseña recopilada por y alojada en G2.com.

Como una mejor oportunidad, añadiría una opción de gestión de definiciones de componentes de API más accesible. Reseña recopilada por y alojada en G2.com.

Start using day 1, very easy to implement.Also easy to customize to fit your needs and your goals. Reseña recopilada por y alojada en G2.com.

Built for small and medium sized companies. If you need additional segments, multiple sets of API documentaton it can get VERY EXPENSIVE.

Also, product support is non existent for lower tiers. Not a bad thing, but something to think about when selecting your package. Reseña recopilada por y alojada en G2.com.

Love the sandbox environments we give users to test out our APIs right from our docs. They don't need to leave or go elsewhere, everything can happen right there in the documentation. Reseña recopilada por y alojada en G2.com.

I wish they offered an area to test out websockets. Right now the area to test out APIs is top notch. But we started offering websockets and that requires users to leave the docs to test them Reseña recopilada por y alojada en G2.com.

Fácil colaboración en equipo, fácil manejo de proyectos, el editor se ve genial, así que pulgares arriba por eso. Reseña recopilada por y alojada en G2.com.

Necesita algunas mejoras, la interfaz de usuario es muy limpia, pero en algún lugar, cuando se muestra a otros usuarios, le falta un poco de interacción. Reseña recopilada por y alojada en G2.com.

It's user interface and display is aesthetically nice and intuitive as it's easy to navigate through features. Reseña recopilada por y alojada en G2.com.

I think ReadMe has a lot of great features that are just gated for higher subscriptions -- too pricey. Reseña recopilada por y alojada en G2.com.

La facilidad de uso es impresionante; es directo y muy poderoso mientras sigue siendo simple de usar. Me gusta especialmente que puedas tener un diseño molecular para tus documentos; es decir, puedes hacer muchas divisiones y niveles de información. También creo que algo genial de Readme es la facilidad de agregar cosas diferentes al texto (imágenes, tablas y ejemplos de código). Por ejemplo, es genial que puedas tener múltiples versiones de los ejemplos de código y también el resultado/respuesta esperada.

En general, creo que ReadMe tiene la mayoría de lo que podrías necesitar para crear cualquier documentación de sitio web/servicio. Reseña recopilada por y alojada en G2.com.

Esto realmente no es algo malo, pero me encantaría si pudieras tener una vista previa lado a lado de cómo se vería el documento, y no tener que abrir una nueva pestaña para verlo.

Para el resto, para lo que mis colegas y yo usamos ReadMe, genuinamente no puedo encontrar otras cosas que no me gusten. Reseña recopilada por y alojada en G2.com.

Straight out of the box, Readme looks stunning. If you care about providing a satisfying user experience, using a Readme developer hub is the way to go. In my experience using other developer hubs powered by Readme, the server API Reference feature makes it incredibly easy to understand, get samples for and try out various API methods. At our company, we synchronise our client API reference generated in markdown to our Guides section using the Readme API. A handy feature of Readme for providing code samples is Recipes - where you can create a step-by-step walkthrough guide of sample code. I've found these enjoyable to write, and they form an integral part of our feature guides for developers. Reseña recopilada por y alojada en G2.com.

As great as Readme is, the content editing experience feels quite limited to what markdown can provide. I want more powerful layout features in guides, such as columns. While it's possible to add custom content using HTML/CSS, it would be nicer for Readme to have a more powerful WYSIWYG editor.

When our dashboard got the new editor, I found it stripped many of the features of the previous editor and felt more like an inconvenience. The support team were able to switch us back to the legacy editor.

Images are slow to load on Readme; I would expect some form of optimisation on the platform side. There is no option to host files such as sample projects and demos, which has been a pain point for our team since it's preferable to host everything in one place (on the developer hub).

While the overall website looks fantastic, sometimes minor bugs impede the experience, and it isn't communicated when a release with bug fixes is out. While the suggested edits feature is good, the editing experience is comparably worse than the one provided to editors.

Overall, it's a good platform, but it can feel inconsistent in places - which may be a side-effect of the platform being updated frequently. Reseña recopilada por y alojada en G2.com.

Readme es extremadamente fácil de usar y lanzar tu documentación. Si eres una startup, es una opción estupenda mientras piensas en cómo explicar las capacidades de tu producto y cómo puede ser utilizado por tu mercado objetivo.

Sus herramientas para desarrolladores son excelentes y facilitan mucho a los desarrolladores que usan diferentes lenguajes entender cómo usar el sistema y lograr un tiempo más rápido para obtener valor. Reseña recopilada por y alojada en G2.com.

Readme está diseñado para plataformas tecnológicas que desean permitir a los clientes servirse por sí mismos. Readme también está construido sobre este modelo de autoservicio: su compromiso con el cliente y su hoja de ruta aún están evolucionando. Pero la buena noticia es que su equipo es muy receptivo a los comentarios y busca activamente la opinión de su base de clientes. Esta es una plataforma en ascenso. Reseña recopilada por y alojada en G2.com.

Readme proporciona una interfaz poderosa que te permite crear y gestionar versiones de documentación con facilidad. La edición en Markdown es poderosa para crear información estructurada, y la creación de plantillas de página es fácil de manejar. ¡Gran herramienta! Reseña recopilada por y alojada en G2.com.

No puedo pensar en nada que no me guste de la herramienta. Reseña recopilada por y alojada en G2.com.

Readme es muy rico en funciones. Lo hace simple para que el equipo de tecnología haga conocer sus cambios a los socios de integración, así como para que el equipo de negocios y marketing dé su toque a los documentos. Facilita mostrar cambios, resaltar "cosas buenas de saber" e incluso proporcionar recetas para la integración. Reseña recopilada por y alojada en G2.com.

Una cosa que me gustaría cambiar es facilitar que la tecnología y el negocio trabajen juntos en las páginas. Cuando la página toma los documentos directamente del código, es difícil para el negocio agregar su toque, ya que se sobrescribirá cada vez. Si las páginas pudieran ser híbridas o tener alguna funcionalidad de bloqueo, sería fantástico. Reseña recopilada por y alojada en G2.com.