Sebastián R.
SR
Sebastián R.
Customer Success Representative
Small-Business (50 or fewer emp.)
"Plain and simple. It works great."
5/5
What do you like best about ReadMe?

The ease of use is awesome; it is straightforward and very powerful while being simple to use. I especially like that you can have a molecular design for your Docs; that is, you can make many divisions and levels of information. I also think that something great about Readme is the ease of adding in things different than text (images, tables and Code examples). For example, it's great that you can have multiple versions of the code examples and also the expected result/response.

In general, I think that ReadMe has most of what you could need for creating any Website/Service documentation. Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

This really isn't something bad, but I'd love if you could have a side-by-side preview of how the Doc would look, and not have to actually open a new tab to view it.

For the rest of it, for what my colleagues and I use ReadMe for, I genuinely can't find any other things that I don´t like. Review collected by and hosted on G2.com.

Verified User in Computer Games
TC
Verified User in Computer Games
Small-Business (50 or fewer emp.)
"A great place to create your API documentation"
4/5
What do you like best about ReadMe?

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. Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

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. Review collected by and hosted on G2.com.

Andrew C.
AC
Andrew C.
Group Product Manager
Small-Business (50 or fewer emp.)
"Developer documentation is marketing for tech platforms. Readme makes that marketing easy."
4.5/5
What do you like best about ReadMe?

Readme is extremely easy to get use and launch your documentation. If you are a startup, it is a terrific option as you are thinking about how to explain your product's capabilities and how it can be used by your target market.

Their developer tools are excellent and make it very easy for developers using different languages to understand how to use the system and achieve a quicker time to value. Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

Readme is built for technology platforms that want to enable customers to self-serve. Readme is also built on this self-serve model - its customer engagement and roadmap is still evolving. But the good news is that its team is very responsive to feedback and actively seeks input from its customer base. This is a platform on the rise. Review collected by and hosted on G2.com.

Chris C.
CC
Chris C.
Chief Operating Officer
Small-Business (50 or fewer emp.)
"Great tool for creating and sharing API documentation"
5/5
What do you like best about ReadMe?

Readme provides a powerful interface that allows you to create and manage documentation versions with ease. The Markdown editing is powerful for creating structured information, and the page templating is easy to work with. Great tool! Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

I can't think of anything I don't like about the tool. Review collected by and hosted on G2.com.

Justin L.
JL
Justin L.
Director Of Engineering
Mid-Market (51-1000 emp.)
"Great Product to decrease integration time."
5/5
What do you like best about ReadMe?

Readme is very feature rich. It makes it simple for the technology team to make their changes known to integrating partners as well as business and marketing to give their touch to the documents. It makes it easy to display changes, highlight "good to knows" and even proivde recipes for integrating. Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

One thing I would like to change is make it easier for the technology and business to work together on pages. When the page is taking the docs straight from the code, it makes it hard for business to add their touch as it will get overwritten every time. If the pages could be hybrid or have some locking functionality that would be fantastic. Review collected by and hosted on G2.com.

Michael D.
MD
Michael D.
Lead Software Engineer
Small-Business (50 or fewer emp.)
"Great product - auto-generating API docs from OpenAPI reference makes life easy"
4.5/5
What do you like best about ReadMe?

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.

What do you dislike about ReadMe?

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.

Noah P.
NP
Noah P.
Product Manager
Mid-Market (51-1000 emp.)
"Good software for a simple documentation hub"
4/5
What do you like best about ReadMe?

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.

What do you dislike about ReadMe?

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.

Will T.
WT
Will T.
Senior Demo Engineer
Mid-Market (51-1000 emp.)
"Provides our developers with best-in-class documentation."
5/5
What do you like best about ReadMe?

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.

What do you dislike about ReadMe?

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.

OM
Ori M.
Small-Business (50 or fewer emp.)
"Just excellent"
5/5
What do you like best about ReadMe?

Great integration with OpenAI. Lovely design and UI, really professional. Documentaion area is flawless. Review collected by and hosted on G2.com.

What do you dislike about ReadMe?

"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.

Verified User in Computer Software
AC
Verified User in Computer Software
Mid-Market (51-1000 emp.)
"Simple and effective"
5/5
What do you like best about ReadMe?

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.

What do you dislike about ReadMe?

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.