ReadMe is a very new tool and I have not used it much, but what we are doing right now is great, so I do not think there is any improvement needed. One thing is that I think there is some limitation with customization. ReadMe should give more customization options to users so that we can customize the layout according to our needs. It should not be something that is strict with limited features. I do not think there are any other improvements needed for ReadMe that I have not mentioned yet.
For our internal APIs that move quickly with frequent minor schema changes, the versioning felt more rigid than we wanted. We ended up simplifying our branching strategy to fit ReadMe's model. ReadMe has limited support for non-REST APIs. We also have GraphQL queries sometimes, and those we use with built-in tools that ship together with the NuGet packages we include. We have not yet integrated GraphQL, and I do not know if it is even possible to add it. ReadMe has an MCP server to better integrate with agents or chat, and this is enabled by default, which I do not prefer. It is not good practice; it should be enabled only when needed. ReadMe is a software-as-a-service offering only, and there is no way to self-host ReadMe. We would like to do so, but this option is not available.
Overall, I have had a positive experience with ReadMe, but there are a few areas where I think it could improve. One is customization. While it is easy to create clean documentation, making deeper UI or layout customizations can be somewhat limiting without additional effort. Having more built-in customization options would help teams tailor the developer portal to their branding and documentation needs. I would also like to see more advanced analytics. It would be useful to have richer insights into which APIs are viewed most frequently, where developers spend the most time, and which document pages generate the most support requests. Those metrics could help us continuously improve our documentation. Another improvement would be the tighter integration with Git-based development workflows. While synchronizing documentation works well, making documentation updates, previews, and reviews even more seamless as part of the pull request process would improve the developer experience. All of these are not major issues. They are enhancements that would make an already solid platform even better. Overall, ReadMe has worked well for our API documentation needs. An additional improvement I would like to see is better support for documentation versioning and change tracking. In enterprise applications, APIs evolve over time, and having more intuitive tools to compare versions and clearly highlight changes would make it easier for both internal teams and external consumers to adopt new API versions. I would also appreciate more built-in collaboration features, such as richer review workflows or commenting capabilities for documentation changes before they are published. That would make it easier for developers, QA teams, and technical writers to review documentation together and keep it accurate. Other than those enhancements, I think ReadMe is an easy-to-use platform that has met our API documentation needs. I do not have any major concerns beyond the improvements I already mentioned.
While ReadMe is highly effective, there are a few areas where we see room for improvement. As an engineering team, we prefer writing our documentation locally in Markdown within our code repositories. While ReadMe offers a CLI tool to sync files, the setup can sometimes be finicky. We need a more seamless, native GitHub integration that automatically syncs and previews pull requests. The advanced customization constraints present another area for improvement. While basic styling is simple, deeper layouts and customization often require more advanced CSS scripts and overrides. This feels rigid and can break locally when ReadMe updates its core platform styling. We would love to see a more robust, low-code layout builder. We could probably have more advanced analytics, multi-domain support, or something similar, and advanced access controls. These are locked behind higher enterprise pricing tiers, which can probably be reduced or made more accessible for a growing team like us. We are probably looking at a more flexible, modular pricing model, which would be beneficial.
ReadMe facilitates seamless integration of complex technical documentation into service platforms. With its intuitive interface, ReadMe enhances documentation creation and interaction by enabling real-time collaboration and dynamic content presentation.ReadMe empowers development teams by offering a dynamic platform for creating, managing, and sharing intricate technical documentation. Its capabilities cater to the needs of teams seeking to improve communication and streamline documentation...
ReadMe is a very new tool and I have not used it much, but what we are doing right now is great, so I do not think there is any improvement needed. One thing is that I think there is some limitation with customization. ReadMe should give more customization options to users so that we can customize the layout according to our needs. It should not be something that is strict with limited features. I do not think there are any other improvements needed for ReadMe that I have not mentioned yet.
For our internal APIs that move quickly with frequent minor schema changes, the versioning felt more rigid than we wanted. We ended up simplifying our branching strategy to fit ReadMe's model. ReadMe has limited support for non-REST APIs. We also have GraphQL queries sometimes, and those we use with built-in tools that ship together with the NuGet packages we include. We have not yet integrated GraphQL, and I do not know if it is even possible to add it. ReadMe has an MCP server to better integrate with agents or chat, and this is enabled by default, which I do not prefer. It is not good practice; it should be enabled only when needed. ReadMe is a software-as-a-service offering only, and there is no way to self-host ReadMe. We would like to do so, but this option is not available.
Overall, I have had a positive experience with ReadMe, but there are a few areas where I think it could improve. One is customization. While it is easy to create clean documentation, making deeper UI or layout customizations can be somewhat limiting without additional effort. Having more built-in customization options would help teams tailor the developer portal to their branding and documentation needs. I would also like to see more advanced analytics. It would be useful to have richer insights into which APIs are viewed most frequently, where developers spend the most time, and which document pages generate the most support requests. Those metrics could help us continuously improve our documentation. Another improvement would be the tighter integration with Git-based development workflows. While synchronizing documentation works well, making documentation updates, previews, and reviews even more seamless as part of the pull request process would improve the developer experience. All of these are not major issues. They are enhancements that would make an already solid platform even better. Overall, ReadMe has worked well for our API documentation needs. An additional improvement I would like to see is better support for documentation versioning and change tracking. In enterprise applications, APIs evolve over time, and having more intuitive tools to compare versions and clearly highlight changes would make it easier for both internal teams and external consumers to adopt new API versions. I would also appreciate more built-in collaboration features, such as richer review workflows or commenting capabilities for documentation changes before they are published. That would make it easier for developers, QA teams, and technical writers to review documentation together and keep it accurate. Other than those enhancements, I think ReadMe is an easy-to-use platform that has met our API documentation needs. I do not have any major concerns beyond the improvements I already mentioned.
While ReadMe is highly effective, there are a few areas where we see room for improvement. As an engineering team, we prefer writing our documentation locally in Markdown within our code repositories. While ReadMe offers a CLI tool to sync files, the setup can sometimes be finicky. We need a more seamless, native GitHub integration that automatically syncs and previews pull requests. The advanced customization constraints present another area for improvement. While basic styling is simple, deeper layouts and customization often require more advanced CSS scripts and overrides. This feels rigid and can break locally when ReadMe updates its core platform styling. We would love to see a more robust, low-code layout builder. We could probably have more advanced analytics, multi-domain support, or something similar, and advanced access controls. These are locked behind higher enterprise pricing tiers, which can probably be reduced or made more accessible for a growing team like us. We are probably looking at a more flexible, modular pricing model, which would be beneficial.