A documenta\u00e7\u00e3o de um produto de software \u00e9 uma etapa vital para a prepara\u00e7\u00e3o e o acompanhamento do lan\u00e7amento. Voc\u00ea pode estar interessado em criar manuais de produtos, guias de usu\u00e1rio ou documentos de refer\u00eancia, que podem ajudar na ado\u00e7\u00e3o do seu produto pelos usu\u00e1rios e at\u00e9 mesmo ser essenciais para a conformidade legal.<\/p>\r\n
N\u00e3o basta usar uma ferramenta gen\u00e9rica, como o Google Docs, e esperar gerar uma documenta\u00e7\u00e3o de alta qualidade que seja adequada \u00e0 finalidade. Voc\u00ea precisa de ferramentas especializadas, chamadas de software de base de conhecimento<\/a>, que ofere\u00e7am toda a funcionalidade necess\u00e1ria para criar documenta\u00e7\u00e3o t\u00e9cnica<\/a> com rapidez.<\/p>\r\n Existem muitas ferramentas que o ajudam a publicar sua documenta\u00e7\u00e3o, inclusive o GitBook. Embora o GitBook seja uma excelente op\u00e7\u00e3o em alguns casos, voc\u00ea tamb\u00e9m deve considerar ferramentas alternativas, como o Document360 ou o Confluence. Esperamos que esta postagem torne sua busca pela ferramenta de documenta\u00e7\u00e3o certa um pouco mais f\u00e1cil.<\/p>\r\n O GitBook \u00e9 um software de documenta\u00e7\u00e3o para equipes t\u00e9cnicas, especialmente para redatores t\u00e9cnicos e desenvolvedores de software. O GitBook oferece uma maneira poderosa de criar, organizar e sincronizar seu conte\u00fado t\u00e9cnico para usu\u00e1rios internos ou externos do seu produto ou at\u00e9 mesmo criar documenta\u00e7\u00e3o para suas equipes que trabalham em projetos t\u00e9cnicos. O GitBook \u00e9 especialmente adequado para equipes t\u00e9cnicas que desejam se integrar ao GitHub, com a capacidade de sincronizar sua documenta\u00e7\u00e3o e preservar vers\u00f5es anteriores. O GitBook imita os fluxos de trabalho do Git, como o uso de commits para fazer edi\u00e7\u00f5es e manter os documentos sincronizados com a base de c\u00f3digo – sem a complexidade.<\/p>\r\n O GitBook \u00e9 adequado para qualquer coisa, desde bases de conhecimento internas<\/a> at\u00e9 a documenta\u00e7\u00e3o de APIs<\/a>. Observe que o GitBook \u00e9 gratuito para projetos de c\u00f3digo aberto, organiza\u00e7\u00f5es sem fins lucrativos e estudantes.<\/p>\r\n Agora veremos alguns de seus recursos:<\/p>\r\n Os usu\u00e1rios do GitBook gostam de usar seu editor, que pode ser usado para criar, fazer altera\u00e7\u00f5es e publicar sua documenta\u00e7\u00e3o. Voc\u00ea pode formatar seu texto usando rich text, o que lhe permite usar a paleta inline para fazer altera\u00e7\u00f5es como adicionar links, endere\u00e7os de e-mail, negrito, it\u00e1lico etc. O GitBook suporta Markdown, que permite formatar o conte\u00fado de forma amig\u00e1vel ao teclado, simplificando a renderiza\u00e7\u00e3o do texto. A formata\u00e7\u00e3o do conte\u00fado em blocos permite que voc\u00ea organize o conte\u00fado de diferentes maneiras, incluindo listas, par\u00e1grafos, listas de tarefas, dicas e cita\u00e7\u00f5es.<\/p>\r\n A cria\u00e7\u00e3o de documentos \u00e9 um processo colaborativo, e o GitBook oferece suporte ao controle de vers\u00e3o para ajud\u00e1-lo a gerenciar seu conte\u00fado. O guia Hist\u00f3rico do GitBook permite que voc\u00ea monitore as altera\u00e7\u00f5es, acompanhando o feed, que mostra as altera\u00e7\u00f5es di\u00e1rias que ocorreram, e o hist\u00f3rico de altera\u00e7\u00f5es, que acompanha as altera\u00e7\u00f5es no seu conte\u00fado. Voc\u00ea pode visualizar vers\u00f5es hist\u00f3ricas do conte\u00fado, exibindo a apar\u00eancia do conte\u00fado em um determinado momento, e reverter para vers\u00f5es anteriores clicando no bot\u00e3o de revers\u00e3o.<\/p>\r\nEditores<\/h3>\r\n
Controle de vers\u00e3o<\/h3>\r\n
Colabora\u00e7\u00e3o<\/h3>\r\n