Avaliações e Detalhes do Produto de ReadMe

As receitas e os recursos de documentação OpenAPI são fantásticos, o fato de podermos vincular nossa geração OpenAPI a partir do Github Actions CI através da API ReadMe para atualizar automaticamente nossa documentação é um recurso incrível. Análise coletada por e hospedada no G2.com.

O recurso de bloco de código ao escrever documentação não é ótimo na minha opinião; anteriormente, tínhamos usado o Gitbooks antes de fazermos a transição para o ReadMe e eu sempre adorei a capacidade de simplesmente criar um bloco de código com tags ```. O bloco de código no ReadMe sempre parece um pouco abrangente demais para algumas linhas de script bash. Análise coletada por e hospedada no G2.com.

A estrutura geral do construtor de sites é fácil de usar. A formatação limitada realmente ajuda a evitar que você perca tempo mexendo com configurações frívolas e incentiva um conteúdo conciso e eficaz. Análise coletada por e hospedada no G2.com.

Os recursos empresariais são extremamente caros e é necessário adquirir a versão empresarial para usar qualquer um desses recursos. Coisas como a capacidade de exportar seu site como um PDF parecem não precisar estar atrás dessa barreira. Análise coletada por e hospedada no G2.com.

A capacidade de nossos usuários testarem nossas APIs diretamente no hub de desenvolvedores é extremamente útil. Além disso, poder fornecer aos desenvolvedores receitas que os guiam sobre como desenvolver conceitos e recursos mais desafiadores é muito valioso. Readme tira muito do trabalho de apresentar conteúdo de uma forma que seja útil para os desenvolvedores e nos permite focar no conteúdo real. Análise coletada por e hospedada no G2.com.

Algumas funcionalidades ainda não estão 100% funcionais. Algumas de nossas APIs utilizam uploads de arquivos e a funcionalidade de upload de arquivos do readme não funciona (ainda). Dito isso, os trechos de código gerados são precisos e úteis, mesmo que o botão 'Experimente!' não dispare uma chamada de API bem-sucedida.

Atualização de 8/3/2022 - o readme melhorou a funcionalidade de upload de arquivos e agora nossos desenvolvedores conseguem testar de forma ainda mais eficaz do que antes. Obrigado, equipe do readme! Análise coletada por e hospedada no G2.com.

Ótima integração com a OpenAI. Design e interface adoráveis, realmente profissionais. A área de documentação é impecável. Análise coletada por e hospedada no G2.com.

A seção "Guias" está um pouco com problemas, então evitei. Parece haver uma maneira de adicionar variáveis personalizadas, mas isso não está bem documentado. Análise coletada por e hospedada no 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. Análise coletada por e hospedada no 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. Análise coletada por e hospedada no G2.com.

Os ambientes de teste de API integrados.

A facilidade de atualizar e reordenar os menus.

As edições sugeridas pelos usuários.

Fácil integração com o intercom. Análise coletada por e hospedada no G2.com.

Precisa de uma maneira melhor de capturar solicitações de recursos e mostrar um roteiro. (Eliminaria outro fornecedor nosso) Análise coletada por e hospedada no 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. Análise coletada por e hospedada no 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 :). Análise coletada por e hospedada no 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. Análise coletada por e hospedada no 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. Análise coletada por e hospedada no G2.com.

Diferentes ferramentas para escrever documentação para diferentes tipos de projetos Análise coletada por e hospedada no G2.com.

Muitos formatos tornam difícil fazer uma documentação homogênea. Análise coletada por e hospedada no G2.com.

De uma perspectiva administrativa, a integração do CI tornou muito fácil para toda a nossa equipe técnica de engenheiros poder contribuir para a redação de documentação.

Do lado do usuário final, a navegação, os links permanentes e os testes de API em tempo real são muito legais. As Receitas são um ótimo recurso do qual tiraremos cada vez mais proveito. Análise coletada por e hospedada no G2.com.

Somos usuários iniciais, então não vemos muito do que não gostar no momento. É muito voltado para documentação técnica, seria bom poder consolidar todos os nossos recursos de produto em um só lugar. Isso não parece realista com o Readme. Análise coletada por e hospedada no G2.com.