GitBook: uma plataforma de colaboração que usa IA para auxiliar na criação e na pesquisa de documentos técnicos

O GitBook é uma plataforma on-line que ajuda as equipes a criar, editar e compartilhar documentos técnicos. Ele é compatível com a formatação Markdown e oferece uma interface de edição intuitiva para equipes técnicas e usuários não técnicos. O GitBook se integra aos fluxos de trabalho do Git e pode ser sincronizado com o GitHub ou o GitLab para o gerenciamento colaborativo de códigos e documentos. Ele também oferece pesquisa com IA para ajudar os usuários a encontrar conteúdo rapidamente. Com testes gratuitos e planos pagos que oferecem recursos avançados para atender às necessidades da empresa, o GitBook enfatiza a simplicidade e a facilidade de uso para equipes de startups a grandes empresas para documentação de produtos, referência de API ou criação de bases de conhecimento internas.

Lista de funções

• Criação e edição de documentosSuporte para editores Markdown e WYSIWYG para criar documentação técnica estruturada.
• Sincronização do GitSincronização bidirecional com o GitHub ou o GitLab, para que a documentação seja consistente com o código.
• Pesquisa e insights de IAPesquisa com IA integrada para localizar rapidamente o conteúdo do documento e fornecer análise de conteúdo duplicado ou desatualizado.
• Trabalho em equipeSuporte a edição, comentários e solicitações de alteração em tempo real por várias pessoas, facilitando o trabalho em equipe.
• Marca personalizadaSuporte para personalização de domínios, temas e estilos para criar documentos com a sua marca.
• gerenciamento de direitosControle de permissões: fornece controle de permissões com granularidade fina, adequado para documentos internos e públicos.
• Suporte a vários idiomasSuporte para traduções internacionalizadas, adaptadas a usuários globais.
• importação de conteúdoSuporte para importação de conteúdo de plataformas externas e migração rápida de documentos existentes.
• Publicar e compartilharPublicação de documentos com um clique e suporte para compartilhamento público ou restrito.

Usando a Ajuda

O GitBook é uma plataforma de documentação baseada em nuvem que não requer instalação de software para que os usuários comecem a usá-lo, bastando acessá-lo por meio de um navegador. Abaixo está um guia detalhado para ajudar os usuários a começar rapidamente.

1. registro e login

Para usar o GitBook, primeiro você precisa criar uma conta. Visite https://www.gitbook.com/Em seguida, clique no botão "Start for free" (Iniciar gratuitamente). Os usuários podem optar por se registrar usando o GitHub, o Google ou o e-mail. Após o registro, um e-mail de verificação será enviado, portanto, clique no link do e-mail para ativar sua conta. Depois de ativada, insira o nome da organização (você pode usar seu próprio nome para projetos pessoais) e selecione um cenário de uso (por exemplo, documentação do produto ou base de conhecimento interna). Depois de concluir a configuração, o usuário será direcionado para o painel do GitBook.

2. criação de espaço para documentos

No painel, clique no botão "Create a new space" (Criar um novo espaço) para começar a criar um espaço para documentos. Um espaço é um contêiner para documentos e pode ser usado para armazenar manuais de produtos, documentação de API, etc. Os usuários podem selecionar um modelo (por exemplo, "Book & Manual") para criar rapidamente a estrutura do documento. Insira o título e a descrição do espaço. Essas informações afetarão os resultados de indexação do mecanismo de pesquisa, portanto, é recomendável usar um título claro e conciso, como "Product X User Guide" (Guia do usuário do produto X).

3. edição de documentos

O GitBook oferece duas opções de edição: Markdown e um editor WYSIWYG (What You See Is What You Get).

• Editor MarkdownUsuários que dominam o Markdown podem inserir a sintaxe do Markdown diretamente. Entrada / Acesse o menu de comandos e insira títulos, listas, blocos de código, etc.
• Editor WYSIWYGUsuários não técnicos podem operar o editor visual clicando no espaço em branco da página para adicionar texto, imagens ou tabelas. Arraste o ícone de cartão no lado esquerdo da página para ajustar a ordem do conteúdo.
  Para adicionar uma nova página, clique no botão "+ Adicionar nova página" na coluna da esquerda ou clique em "..." em uma página existente e selecione "Adicionar nova página ". Os usuários também podem usar a função "Importar" para importar páginas de plataformas externas, como Noção (ou Confluence) para importar conteúdo clicando em "Add New Page" (Adicionar nova página) e selecionando "Import Pages" (Importar páginas) e, em seguida, inserindo um link ou carregando um arquivo.

4. configurações de sincronização do Git

O Git Sync do GitBook é um recurso essencial para equipes de desenvolvimento acostumadas a fluxos de trabalho de código.

• Conexão com repositórios GitSelecione seu espaço no painel, clique em "Settings" > "Git Sync" e selecione GitHub ou GitLab para obter autorização. Depois de autorizado, selecione os repositórios e as ramificações que deseja sincronizar.
• Sincronização bidirecionalO GitBook é compatível com a sincronização de conteúdo do espaço do GitBook para repositórios do Git ou com a importação de conteúdo de repositórios do Git para o GitBook, e o GitBook gera automaticamente um registro de confirmação após cada edição para manter os documentos consistentes com o código.
• advertênciaVerifique se as permissões do seu repositório Git estão definidas corretamente. Se a sincronização estiver demorando muito, verifique sua conexão de rede ou entre em contato com o Suporte do GitBook (support@gitbook.com).

5. colaboração e gerenciamento de competências

O GitBook oferece suporte à colaboração entre várias pessoas. Clique na opção "Membros" nas configurações do seu espaço, insira os endereços de e-mail dos seus colegas de equipe para convidá-los a participar e atribua funções (como editor ou visualizador). Os editores podem editar documentos em tempo real, comentar sobre eles ou enviar solicitações de alteração. As solicitações de alteração exigem revisão e são adequadas para equipes empresariais que precisam manter um controle rígido sobre o conteúdo. O gerenciamento de permissões oferece suporte a configurações refinadas, como restringir a visibilidade de determinadas páginas apenas a determinados usuários.

6. publicação de documentação

Quando terminar de editar, clique no botão "Publicar" no canto superior direito (tecla de atalho.):Cmd+S talvez Ctrl+S). Por padrão, o documento é privado e visível apenas para os membros da equipe. Para torná-lo público, clique no botão "Compartilhar" e ative a opção "Público" para gerar um link público. Os usuários também podem definir um domínio personalizado (é necessário um plano pago), configurado em "Settings" > "Custom Domain". Após a publicação, o documento gera automaticamente um índice e uma caixa de pesquisa para facilitar a navegação.

7. uso de IA para pesquisa e insights

O recurso de pesquisa de IA do GitBook localiza rapidamente o conteúdo. Os usuários inserem palavras-chave na página do documento e a IA retorna resultados relevantes com base no contexto. O Insights analisa documentos para sinalizar conteúdo duplicado ou desatualizado. Visite a guia Insights para ver as recomendações do sistema e otimizar os documentos.

8. outras funções

• Suporte a vários idiomasAtivar vários idiomas em "Configurações" > "Internacionalização" para adicionar traduções.
• Exportação de PDFClique no botão "Export" para exportar o documento para PDF, que é adequado para compartilhamento off-line.
• Atalhos de tecladoComo Ctrl+B Em negrito.Ctrl+I Itálico para melhorar a eficiência da edição.

Os usuários podem experimentar o GitBook gratuitamente e fazer upgrade para um plano pago quando adicionarem membros à equipe. Mais ajuda está disponível na documentação oficial:https://docs.gitbook.com/.

cenário do aplicativo

1. Documentação do produto
   O GitBook é ideal para criar guias de usuário para produtos de software. Os desenvolvedores podem escrever procedimentos de instalação, instruções de uso e perguntas frequentes, e sincronizar com o Git para manter a documentação consistente com o código.
2. Referência da API
   As equipes técnicas podem usar o GitBook para organizar a documentação da API, adicionar amostras de código e casos de teste interativos para que os desenvolvedores se atualizem.
3. Base de conhecimento interna
   As empresas podem criar wikis internos para armazenar centralmente documentos de processos, materiais de treinamento, etc., e oferecer suporte ao controle de acesso para garantir a segurança de informações confidenciais.
4. Documentação de projeto de código aberto
   A comunidade de código aberto pode aproveitar o programa gratuito do GitBook para publicar a documentação do projeto, atrair colaboradores e otimizar a colaboração.

QA

1. O GitBook requer a instalação de um software?
   Não, o GitBook é uma plataforma baseada em nuvem, acessível por meio de um navegador.
2. Quais são as limitações do plano gratuito?
   O plano gratuito é adequado para indivíduos ou pequenas equipes e oferece suporte aos recursos básicos de documentação, mas os recursos avançados, como domínios personalizados e permissões avançadas, exigem um plano pago.
3. Como faço para sincronizar com o GitHub?
   Ative o Git Sync nas configurações de seu espaço, autorize sua conta do GitHub e selecione seus repositórios e branches para sincronizar em ambas as direções.
4. Há suporte para usuários não técnicos?
   Sim, o GitBook oferece um editor WYSIWYG intuitivo que permite que usuários não técnicos editem documentos sem precisar aprender Markdown.
5. Como entro em contato com a equipe de suporte?
   aprovar (um projeto de lei ou inspeção etc.) support@gitbook.com Ou entre em contato com a equipe de suporte na página "Fale conosco" do site.