Partilhar via


Documentar suas extensões com a ferramenta ALDoc para parceiros

Importante

Esse conteúdo está arquivado e não está sendo atualizado. Para obter a documentação mais recente, acesse Novidades ou alterações no Business Central. Para ver os planos de lançamento mais recentes, acesse Planos de lançamento do Dynamics 365, do Power Platform e do Cloud for Industry.

Habilitado para Versão preliminar pública Disponibilidade geral
Administradores, criadores, profissionais de marketing ou analistas, automaticamente 17 de agosto 2023 2 de out. de 2023

Valor do negócio

O Business Central tem um número grande e em constante crescimento de aplicativos ISV no AppSource, alguns dos quais em desenvolvimento por aplicativos do mesmo editor, por outros editores e revendedores (na forma de extensões por locatário). Para ajudar no consumo de aplicativos downstream, a documentação é um grande benefício, mas até agora tem sido um processo manual trabalhoso criar e manter isso sincronizado com as alterações do aplicativo, a menos que o próprio editor tenha investido em automação.

Com base nos investimentos recentes em documentação gerada para a base, sistema e outros aplicativos próprios do Business Central, estamos oferecendo aos editores uma nova ferramenta ALDoc. Isso permite gerar documentação a partir de informações simbólicas e sintáticas, comentários de código e estrutura geral do aplicativo com base em arquivos .app de entrada. Os editores podem hospedar a documentação resultante internamente (por exemplo, para uso de P&D) ou externamente para parceiros downstream.

A geração de conteúdo com base no código-fonte tem muitas vantagens, como precisão, 100% de reflexão da base de código atual, documentação menos propensa a erros e economia de tempo.

Detalhes do recurso

Temos o prazer de anunciar que, com a última atualização de pré-lançamento da extensão de Linguagem AL para o Microsoft Dynamics 365 Business Central, incluímos uma versão preliminar da ferramenta ALDoc para parceiros.

A ferramenta ALDoc gera documentação a partir de informações simbólicas e sintáticas, comentários de código e estrutura geral do aplicativo com base em arquivos .app de entrada. Você pode usá-la para gerar documentação de referência interna ou externa para sua solução.

A ferramenta também gera um site de ajuda com os artigos de referência, classificados pela estrutura da aplicação, com base no modelo personalizado fornecido.

Leia mais sobre a ferramenta em nossos documentos Gerar ajuda com a ferramenta ALDoc.

Além disso, como sempre, queremos saber sua opinião. Use Problemas de AL para obter comentários sobre a ferramenta.

Exemplo de ajuda gerada pelo ALDoc

Diga-nos o que você pensa

Ajude-nos a melhorar o Dynamics 365 Business Central debatendo ideias, dando sugestões e fazendo comentários. Use o fórum em https://aka.ms/bcideas.

Consulte também

Gerar ajuda com a ferramenta ALDoc (documentos)