Avis et détails du produit de ReadMe

Les recettes et les fonctionnalités de documentation OpenAPI sont fantastiques, le fait que nous puissions lier notre génération OpenAPI à partir de Github Actions CI via l'API ReadMe pour mettre à jour automatiquement notre documentation est une fonctionnalité incroyable. Avis collecté par et hébergé sur G2.com.

La fonctionnalité de bloc de code lors de la rédaction de documentation n'est pas géniale à mon avis ; auparavant, nous avions utilisé Gitbooks avant de passer à ReadMe et j'ai toujours aimé la possibilité de simplement créer un bloc de code avec des balises ``` - le bloc de code dans ReadMe semble toujours un peu trop complet pour quelques lignes de script bash. Avis collecté par et hébergé sur G2.com.

La structure générale du créateur de site est facile à utiliser. La mise en forme limitée aide en fait à éviter de perdre du temps avec des réglages futiles et encourage un contenu concis et efficace. Avis collecté par et hébergé sur G2.com.

Les fonctionnalités d'entreprise sont extrêmement coûteuses et vous devez acheter l'édition entreprise pour utiliser l'une de ces fonctionnalités. Des choses comme la possibilité d'exporter votre site en PDF semblent ne pas avoir besoin d'être derrière ce mur. Avis collecté par et hébergé sur G2.com.

La capacité pour nos utilisateurs de tester nos API directement dans le hub des développeurs est extrêmement utile. En plus de cela, pouvoir fournir aux développeurs des recettes qui les guident sur la façon de développer des concepts et des fonctionnalités plus complexes est très précieux. Readme enlève beaucoup de travail pour faire apparaître le contenu d'une manière utile aux développeurs et nous permet de nous concentrer sur le contenu réel. Avis collecté par et hébergé sur G2.com.

Certaines fonctionnalités ne sont pas encore 100 % fonctionnelles. Certaines de nos API utilisent le téléchargement de fichiers et la fonctionnalité de téléchargement de fichiers de readme ne fonctionne pas (encore). Cela dit, les extraits de code générés sont précis et utiles même si le bouton 'Try It!' ne déclenche pas un appel API réussi.

Mise à jour du 03/08/2022 - readme a amélioré la fonctionnalité de téléchargement de fichiers et maintenant nos développeurs peuvent tester encore plus efficacement qu'auparavant. Merci à l'équipe readme ! Avis collecté par et hébergé sur G2.com.

Grande intégration avec OpenAI. Design et interface utilisateur magnifiques, vraiment professionnels. La zone de documentation est impeccable. Avis collecté par et hébergé sur G2.com.

La section "Guides" est un peu boguée, donc j'ai évité. Il semble y avoir un moyen d'ajouter des variables personnalisées, mais cela n'est pas bien documenté. Avis collecté par et hébergé sur 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. Avis collecté par et hébergé sur 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. Avis collecté par et hébergé sur G2.com.

Les environnements de test API intégrés.

La facilité de mise à jour et de réorganisation des menus.

Les modifications suggérables par les utilisateurs.

Intégration facile avec Intercom. Avis collecté par et hébergé sur G2.com.

Un meilleur moyen de capturer les demandes de fonctionnalités et de montrer une feuille de route. (Éliminerait un autre de nos fournisseurs) Avis collecté par et hébergé sur 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. Avis collecté par et hébergé sur 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 :). Avis collecté par et hébergé sur 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. Avis collecté par et hébergé sur 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. Avis collecté par et hébergé sur G2.com.

Différents outils pour rédiger la documentation pour différents types de projets Avis collecté par et hébergé sur G2.com.

Trop de formats rendent difficile la création d'une documentation homogène. Avis collecté par et hébergé sur G2.com.

D'un point de vue administratif, l'intégration CI a rendu très facile pour toute notre équipe technique d'ingénieurs de pouvoir contribuer à la rédaction de la documentation.

Du côté de l'utilisateur final, la navigation, les permaliens et les tests d'API en temps réel sont très intéressants. Les recettes sont une excellente fonctionnalité dont nous tirerons de plus en plus parti. Avis collecté par et hébergé sur G2.com.

Nous sommes des utilisateurs précoces, donc nous ne voyons pas grand-chose à ne pas aimer pour le moment. Il est très adapté à la documentation technique, ce serait bien de pouvoir consolider toutes nos ressources produit en un seul endroit. Cela ne semble pas réaliste avec Readme. Avis collecté par et hébergé sur G2.com.