Escreva, teste, compile e publique as melhores versões de TutoriaisInstruções passo a passoreferências de APIGuias do usuárioDocumentação da SDK

O ambiente de desenvolvimento mais poderoso – agora adaptado para escrever documentação

Documentos como código prontos para uso

Pipeline de documentos como código

Use um único ambiente de autoria, eliminando a necessidade de trabalhar com muitas ferramentas ao mesmo tempo. Com a UI do Git integrada, uma ferramenta de build integrada, testes automatizados e um layout personalizável e pronto para uso, você pode se concentrar no que é mais importante: seu conteúdo.

Markdown e XML combinados

Agora, você pode combinar as vantagens do Markdown com as da marcação semântica. Use um formato ou enriqueça o Markdown com atributos e elementos semânticos, diagramas Mermaid e fórmulas matemáticas LaTeX.

Automação da qualidade dos documentos

Garanta a qualidade e a integridade da documentação com mais de 100 inspeções dinâmicas no editor, bem como testes na Live Preview e durante o build.

Visualização ao vivo

A visualização mostra os documentos exatamente como seus leitores os verão. Visualize uma única página no IDE ou abra todo o site de ajuda no seu navegador sem executar o build.

Fonte única

Reutilize qualquer coisa, desde pequenos trechos de conteúdo até tópicos ou seções inteiras do seu sumário. Mantenha a flexibilidade com filtros e variáveis. Use modelos predefinidos para elementos de marcação complexos ou configure os seus próprios.

Documentos de API e de produto, monte!

Chega de alternar entre diferentes ferramentas ao criar a documentação do usuário e as referências de API. Incorpore documentos da API no seu site de ajuda, publique-os no mesmo layout e complemente referências automaticamente geradas com conteúdo manualmente escrito.

Veja como funciona

Criado por documentaristas...
para documentaristas

Esse projeto foi desenvolvido a partir de centenas de entrevistas com clientes e mais de 10 anos de trabalho na documentação da Plataforma IntelliJ. Essas experiências nos deram uma longa lista de recursos a serem criados e problemas a serem resolvidos. Estamos aqui para lidar com cada um deles.

Quer ajudar? Experimente o Writerside e conte-nos o que você achou!

Use o Writerside para criar documentos como estes

Muitos produtos da JetBrains já usam nossa plataforma de documentação. E agora, você pode usar todo o nosso conhecimento, experiência e modelos para criar documentos para seus próprios produtos.

Perguntas frequentes

O Writerside agora está sendo distribuído como um EAP (Programa de acesso antecipado) e é totalmente gratuito.

Mesmo após o lançamento do Writerside, teremos uma versão gratuita ou um programa EAP em andamento, para que você possa continuar usando a ferramenta gratuitamente.

O Writerside tem dois tipos de arquivos de origem: Markdown e XML, mas isso não significa que você precise se limitar a um único formato. Você pode escrever em Markdown e injetar elementos mais complicados, como atributos semânticos e elementos XML. Ambas as marcações têm assistência completa do editor, que inclui complementação e validação.

Se a sua base de origem principal estiver em XML, você poderá aceitar solicitações de alteração de contribuidores externos em Markdown e converter de Markdown para XML. Da mesma forma, você poderá converter fragmentos de Markdown em XML, por exemplo, se precisar mesclar células em uma tabela.

Esperamos que uma combinação do Markdown e de marcação semântica baseada em XML englobe a maioria dos casos de uso. No entanto, estamos abertos a comentários. Por isso, conte-nos se você não tiver a funcionalidade que outra marcação é capaz de fornecer.

Você pode armazenar arquivos localmente, mas a opção recomendada é usar um repositório Git. Fornecemos uma interface de usuário conveniente para todas as operações do Git, gerenciando branches e resolvendo conflitos. Você também pode usar outro sistema de controle de versão compatível, como o Subversion ou o Perforce.

Apesar de acreditarmos em documentação baseada na Web, às vezes as pessoas ainda precisam produzir documentação em formatos impressos. Neste momento (janeiro de 2024), oferecemos suporte à saída em PDF.

O Writerside permite que você crie seu projeto de documentação localmente e gere um arquivo .zip. Em seguida, você precisará enviá-lo ao seu site ou hospedá-lo no GitHub Pages, na Amazon AWS, no Netlify ou qualquer outro serviço de hospedagem. Estamos pensando em fornecer nosso próprio serviço de hospedagem de documentos em algum momento no futuro.

Se você usa um servidor CI/CD, podemos fornecer scripts de build como um container do Docker que você pode usar para configurar builds de documentação.

Você pode configurar o Writerside para produzir índices de pesquisa do Algolia e pode se registrar para um plano gratuito do Algolia.

Também estamos trabalhando em nossa própria solução de pesquisa.

A versão inicial do Writerside oferece algumas opções de personalização. Aqui estão alguns exemplos do que você pode fazer:

  • Altere a aparência do cabeçalho e rodapé.
  • Adicione seu logotipo e direitos autorais.
  • Escolha entre três predefinições de cores (suave, contraste e vívida) que oferecem suporte para temas claros e escuros.
  • Escolha uma cor de destaque para elementos destacados.
  • Incorpore links para redes sociais e outros recursos.

Temos planos para adicionar mais opções e deixar a personalização de documentos ainda mais flexível.

Se você tiver fontes em Markdown, poderá importá-las para um projeto do Writerside. Também estamos trabalhando na migração de formatos baseados em XML, incluindo DITA.

Publicamos atualizações regularmente em nosso espaço de trabalho do Slack (leia nosso Código de Conduta antes de ingressar). Você também pode acompanhar nosso projeto no YouTrack, informar quaisquer problemas que encontrar ou fazer solicitações de recursos.

Você também pode assinar nosso boletim informativo, onde anunciamos todas as principais atualizações do produto.