Início Rápido (Quick Start)

Comece a usar o Doccler e publique seu primeiro site de documentação em poucos minutos.

Este guia explica os passos essenciais para configurar sua conta, criar conteúdo e colocar sua documentação no ar. Ao final deste guia, você terá um site de documentação online, pronto para ser expandido e personalizado.

1. Primeiros Passos

Antes de tudo, você precisará de uma conta para gerenciar seus projetos.

1. Crie sua conta: Acesse o Doccler.app e faça seu cadastro.
2. Seu primeiro espaço: Após criar a conta, você será direcionado automaticamente para um novo site de documentação (espaço), pronto para edição.
3. Escolha seu método: Você verá opções na tela para começar a adicionar conteúdo imediatamente, seja importando ou criando do zero.

Nota: Seu conteúdo começa como Rascunho (Draft). Isso significa que você pode editar, personalizar e visualizar seu site livremente. Ele só ficará visível para o público quando você clicar no botão Publicar.

2. Edite seu Conteúdo

O Doccler oferece flexibilidade para diferentes estilos de trabalho. Você pode escolher uma das opções abaixo ou combinar ambas:

• Editor Visual: Uma interface intuitiva "O que você vê é o que você tem" (WYSIWYG), ideal para edição rápida e direta.
• Documentação como Código: Um fluxo de trabalho sincronizado com repositórios (como GitHub/GitLab), ideal para desenvolvedores.

Fluxo de Ramificações (Branches)

Independentemente do método escolhido, o Doccler utiliza um fluxo de edição baseado em ramificações. Isso garante que suas edições sejam salvas em uma versão separada e segura, sem afetar a documentação que já está no ar até que você decida mesclar as alterações.

3. Personalize seus Documentos

Faça com que a documentação tenha a cara da sua marca antes de lançar.

• Branding: Adicione o logotipo da sua empresa e o ícone do site (favicon).
• Temas: Ajuste as cores para corresponder à identidade visual do seu produto.
• Estrutura: Organize a barra lateral e a navegação para facilitar a leitura.

4. Publique sua Documentação

Satisfeito com o resultado? É hora de lançar.

1. Localize o botão Publicar no canto superior da interface.
2. Confirme a ação.
3. Sua documentação agora está pública e acessível através do link gerado.

Próximos Passos

Agora que o básico está configurado, explore recursos avançados para potencializar o Doccler