ferramenta de compartilhamento de documentos on-line showdoc v3.2.6

ShowDoc é uma ferramenta online de documentação de API e documentação técnica muito adequada para equipes de TI. Por meio do showdoc, você pode usar facilmente a sintaxe de markdown para escrever lindos documentos de API, documentos de dicionário de dados, documentos técnicos, documentos Excel online, etc. Se não quiser editar documentos de markdown, você também pode usar os recursos de automação do showdoc para gerar automaticamente documentos de API a partir de comentários do programa ou gerar documentos automaticamente enquanto depura a interface do cliente RunApi correspondente (uma ferramenta de depuração de API semelhante ao carteiro). Ao atribuir membros do projeto e membros da equipe, você pode gerenciar facilmente as permissões dos documentos do projeto e a colaboração da equipe, e também pode compartilhar documentos com amigos para visualização. ShowDoc também oferece suporte a clientes multiplataforma, incluindo cliente win, cliente mac, ios, android, etc., tornando-o mais conveniente para uso em plataforma cruzada. Atualmente, mais de 100.000 equipes de Internet estão usando o showdoc, incluindo algumas equipes de empresas conhecidas, como Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express, etc.

para que pode ser usado

1. Documentação da API

Com o desenvolvimento da Internet móvel, o BaaS (backend como serviço) está se tornando cada vez mais popular. O servidor fornece uma API e o APP ou front-end da web pode chamar dados facilmente. ShowDoc pode ser usado para escrever belos documentos API de maneira muito conveniente e rápida.

2. Dicionário de dados

Um bom dicionário de dados pode explicar facilmente a estrutura do seu banco de dados para outras pessoas, como a definição de cada campo, etc.

3. Documentação

Você pode usar o showdoc para escrever instruções para algumas ferramentas e também pode escrever alguns documentos de especificações técnicas para a equipe revisar.

Quais funções ele tem

1. Compartilhe e exporte

Web design responsivo, os documentos do projeto podem ser compartilhados em computadores ou dispositivos móveis para visualização. Ao mesmo tempo, você também pode exportar o projeto para um arquivo Word para navegação offline.

2. Gerenciamento de permissões

(1), projetos públicos e projetos privados

Existem dois tipos de projetos no ShowDoc: projetos públicos e projetos privados. Os projetos públicos podem ser acessados ​​por qualquer usuário logado ou não, enquanto os projetos privados exigem uma senha para autenticar o acesso. A senha é definida pelo criador do projeto.

(2) Transferência do projeto

Os criadores de projetos são livres para transferir projetos para outros usuários do site.

(3), membros do projeto

Você pode adicionar e excluir facilmente membros de projetos ShowDoc. Os membros do projeto podem editar o projeto, mas não podem transferir ou excluir o projeto (somente o criador do projeto tem permissão)

(4), gerenciamento de equipe

Você pode colaborar melhor com sua equipe usando a função de equipe do showdoc

3. Função de edição

(1), edição de redução

ShowDoc usa editor de markdown, que oferece excelente experiência de edição e leitura. Se você não conhece o Markdown, pesquise “Compreendendo e começando com o Markdown” no mecanismo de pesquisa

(2) Inserção de modelo

Na página de edição do ShowDoc, clique no botão acima do editor para inserir facilmente modelos de interface API e modelos de dicionário de dados. Após inserir o template, basta alterar os dados, economizando muito esforço de edição.

(3), história

ShowDoc fornece uma função de histórico para a página e você pode facilmente restaurar a página anterior.

4. Multiplataforma

showdoc suporta versão de aplicativo móvel e versão de cliente de computador.

5. Automação

(1) Os documentos podem ser gerados automaticamente a partir de comentários de código

(2), equipado com cliente RunApi, interface de depuração e geração automática de documentos