Top Rated ReadMe Alternatives
41 ReadMe Reviews
Overall Review Sentiment for ReadMe
Log in to view review sentiment.
The recipes and OpenAPI documentation features are fantastic, the fact that we can link our OpenAPI generation up from Github Actions CI through the ReadMe API to automatically update our documentation is an amazing feature. Review collected by and hosted on G2.com.
The code block feature when writing documentation isn't great in my opinion; previously, we had used Gitbooks before we transitioned to ReadMe and I always loved the ability to just create a code block with ``` tags - the code block in ReadMe always feels a little too comprehensive for a few lines of bash script. Review collected by and hosted on G2.com.
The overall structure of the site builder is easy to use. The limited formatting actually helps prevent you from wasting time messing with frivolous settings and encourages concise effective content. Review collected by and hosted on G2.com.
Enterprise features are wildly expensive and you have to buy enterprise to use any one of those features. Things like the ability to export your site as a PDF seem like they don't need to be behind that wall. Review collected by and hosted on G2.com.
The ability for our users to test our APIs right in the developer hub is extremely useful. In addition to that, being able to provide developers with recipes that guide them on how to develop more challenging concepts & features is very valuable. Readme takes a lot of the work out of surfacing content in a way that is useful to developers and lets us focus on the actual content. Review collected by and hosted on G2.com.
Some features are not 100% functional yet. Some of our APIs leverage file-uploads and readme's file-upload feature does not work (yet). That being said, the code snippets generated are accurate and helpful even though the 'Try It!' button does not fire off a successful API call.
8/3/2022 update - readme has improved the file upload functionality and now our developers are able to test even more effectively than before. Thanks readme team! Review collected by and hosted on G2.com.
Great integration with OpenAI. Lovely design and UI, really professional. Documentaion area is flawless. Review collected by and hosted on G2.com.
"Guides" section is a bit buggy, so I avoided. There seems to be a way of adding custom variables, but this is not well documented. Review collected by and hosted on G2.com.
Simple and effective markdown editor and guide creation. Automatically builds REST API reference from open API spec, which keeps the reference data update to date at all times. Version control is nice to have as well as new integration are launched. Review collected by and hosted on G2.com.
There could be stronger branding elements and more widget options within the guides, mainly to consolidate more general documentation/help guides in a single place. Also an email capture option would be awesome. Review collected by and hosted on G2.com.
The built-in API test environments.
The ease of updating and reordering the menus.
The suggestable edits by users.
Easy integration with intercom. Review collected by and hosted on G2.com.
Need a better way to capture feature request and show a roadmap. (Would eliminate another provider of ours) Review collected by and hosted on G2.com.
Save us a tonne of time on documentation and changelogs.
The admin interface is easy to use, and let's us focus on content.
The changelog feature is cute with subtle graphics for item categorizations, and hence easy to glance. Review collected by and hosted on G2.com.
Nothing much, TBH. Do more webinars or QnA sessions for customer success so that we use 90% of its features and not the minimum 50% that we currently do :). Review collected by and hosted on G2.com.
ReadMe offers best practices right in the box. You don't need much background in good API development as simply following all the steps helps. It supports markdown and the UX looks and feels good. There is a lot of automated features like suggestions, changelogs, home pages, code snippet that automates the process. Review collected by and hosted on G2.com.
Full OpenAPI 3.0 support is still quite lacking. In our case have to make a script that crawls all our objects so that ReadMe is unable to process it naturally. It does not have a native notion of what a shared Shema is. This is where Redoc excels at. Review collected by and hosted on G2.com.
From an administration perspective, the CI integration made it very easy for our entire technical team of engineers to be able to contribute to documentation writing.
On the end user side, the navigation, permalinks, and real-time API tests are very cool. The Recipes are a great feature that we will be increasingly taking advantage of. Review collected by and hosted on G2.com.
We are early users so we do not see much to dislike at the moment. It is very tailored to technical documentation, it would be nice to be able to consolidate all of our product resources in one place. That doesn't seem realistic with Readme. Review collected by and hosted on G2.com.
