Compartilhar via

Contribuir para a documentação do Dynamics 365

  • Artigo

Você pode colaborar para a documentação do Dynamics 365 da Microsoft de duas formas. Se um artigo contiver informações incorretas ou confusas, ou se você souber uma boa solução para um problema recorrente, use o link de comentários no artigo para nos informar.

Para a maior parte da nossa documentação, você também pode editar um artigo diretamente para iniciar um processo de revisão.

Fornecer comentários

No site learn.microsoft.com, cada artigo do Learn oferece a oportunidade para você fornecer comentários. Você pode escolher a ação Comentários que está abaixo do título do artigo no canto superior direito ou uma das opções de comentários na parte inferior do artigo, na seção Comentários. Atribua uma classificação ao artigo, selecione o motivo dos seus comentários e considere deixar um comentário. Os comentários vão para o autor do artigo e para a equipe proprietária dos documentos.

Se não for possível editar um artigo diretamente ou se você não se sentir confortável para fazer a edição, é recomendável usar o mecanismo de comentários para nos dizer o que você pensa sobre o artigo ou o produto.

Colaborações externas à documentação da Microsoft

Os arquivos de origem do nosso conteúdo principal são armazenados em repositórios públicos do GitHub. Qualquer pessoa pode revisá-los e, em muitos casos, editá-los. Suas sugestões e correções são bem-vindas, sejam na forma de contribuições diretas ou como problemas de GitHub para relatar um bug ou fazer uma pergunta. Só podemos aceitar comentários e colaborações para o conteúdo de origem em inglês.

A maioria dos artigos tem um ícone de lápis com a dica de ferramenta Editar este Documento. Selecione o ícone para abrir o artigo no GitHub e inicie a edição. Comece como um colaborador com o Guia do colaborador do Microsoft Learn.

Se você quiser ir mais além e colaborar com novos artigos conceituais, use os modelos em https://github.com/MicrosoftDocs/dynamics365-docs-templates.

Conteúdo de diretrizes do Dynamics 365

O conteúdo de diretrizes do Dynamics 365 usa os mesmos processos da maior parte da documentação no Microsoft Learn. Nesta seção, destacamos ferramentas e processos que você pode usar para ajudar a complementar as diretrizes de implementação.

O termo conteúdo de diretrizes cobre a próxima iteração do guia de implementação do Dynamics 365, descrições de processos de negócios, novos padrões, práticas recomendadas compartilhadas e arquiteturas de referência. Publicamos o primeiro conteúdo de diretrizes em abril de 2023 e adicionamos atualizações a cada duas semanas. Navegue pelo hub de diretrizes e nos dê sua opinião sobre o que é ótimo e o que está faltando.

Parte do conteúdo de diretrizes é fornecida por colaboradores internos. Incentivamos os especialistas no assunto em toda a comunidade a nos ajudar a estabelecer as práticas recomendadas. Continue a leitura se você tiver uma prática recomendada ou outras ideias que você acha que deveriam fazer parte do Microsoft Learn.

Por que colaborar?

Acreditamos que o novo conteúdo de diretrizes ajuda a agilizar os projetos de implementação do Dynamics 365. Nossos parceiros e clientes podem usar as diretrizes para se preparar para a implementação e para desenvolver habilidades em novas áreas ou para novos funcionários. Os desenvolvedores de software podem usar o conteúdo como uma plataforma para promover sua propriedade intelectual ou experiência no setor.

Mas nós, na Microsoft, não somos os únicos especialistas em como implementar soluções com o Dynamics 365. A comunidade inclui pessoas que são especialistas em vários aspectos de implementação. Você tem um padrão, uma prática recomendada, uma configuração ou uma arquitetura de integração que funciona bem em várias implementações? Considere compartilhá-las aqui no Microsoft Learn para tornar toda a comunidade ainda mais produtiva e eficiente em seus projetos de implementação.

Por fim, esperamos poder oferecer recompensas ou outros reconhecimentos para colaborações. Em 2023, reconhecemos os colaboradores nos artigos.

Como colaborar

A partir de novembro de 2023, você poderá encontrar os arquivos de origem do conteúdo de diretrizes do Microsoft Dynamics 365 em um repositório público do GitHub. Você também pode editar os artigos no site learn.microsoft.com/dynamics365/guidance conforme descrito no Guia do colaborador do Microsoft Learn.

Recomendamos que envie correções da mesma forma que você envia uma alteração para outras áreas do Microsoft Learn. No entanto, para enviar conteúdo novo, solicitamos que você faça upload de seus arquivos de Markdown para novo conteúdo de diretrizes para um repositório diferente, Padrões e Práticas do Dynamics 365. Dessa forma, podemos garantir que sua arquitetura de referência ou padrão seja revisado por outros especialistas no assunto. Há diferentes modelos para selecionar e, se você desejar colaborar com o conteúdo do processo de negócios, há um processo diferente em um único local.

Modelos

A Microsoft fornece modelos em dois locais, dependendo do tipo de modelo:

Adicionaremos mais modelos e diretrizes ao longo do tempo. Recomendamos que você siga os repositórios ou salve-os com uma estrela, para que receba uma notificação em caso de qualquer alteração.

Compartilhe seus comentários na guia https://github.com/microsoft/dynamics365patternspractices/discussions do repositório Padrões e Práticas do Dynamics 365.

Se você ainda não tiver uma conta do GitHub, comece com o Guia do colaborador do Microsoft Learn.

Dica

Procure nossos arquivos de origem no repositório https://github.com/MicrosoftDocs/dynamics365-guidance. Aprenda com a forma como estruturamos os diferentes tipos de artigos para que seus artigos sigam a mesma estrutura. Dessa forma, o processo de revisão é mais rápido.

Arquiteturas

Nós damos as boas-vindas às colaborações de diretriz de arquitetura, incluindo ideias de solução e padrões de design. Se você tiver uma implementação de prática recomendada ou referência, envie sua proposta para a equipe do Azure ou para nós do Dynamics 365.

Para colaborar com novos artigos para as diretrizes arquitetônicas do Dynamics 365, siga estas etapas principais:

A Microsoft processa o artigo e o publica como parte da documentação das diretrizes do Dynamics 365.

Para obter uma introdução geral ao conteúdo de diretrizes da Microsoft, consulte o Centro de Arquitetura do Azure. Para o guia de colaborador, consulte Colaborações do Centro de Arquitetura do Azure.

O repositório dynamics365-docs-templates do GitHub contém os modelos de Markdown a seguir para diretrizes arquitetônicas na pasta guidance-templates:

  • Padrão de arquitetura generalizada: um padrão de arquitetura generalizada atua como uma arquitetura principal com uma solução comum que se aplica a vários cenários. Por exemplo, as ideias da solução podem criar um artigo arquitetônico para fornecer uma lente para uma solução de um setor específico ou de parceiro e vincular à arquitetura a partir da ideia de cada solução. O modelo se baseia no modelo do Guia de Arquitetura do Azure. Use-o para tipos diferentes de arquiteturas, incluindo arquiteturas de referência.

  • Ideia de solução: as ideias de solução são as arquiteturas "pequenas" das implementações do Dynamics 365. Elas fornecem visões gerais breves de soluções com o Dynamics 365 e os serviços do Azure. Cada ideia de solução contém os seguintes elementos:

    • Um diagrama de arquitetura
    • Um fluxo de dados
    • Componentes, o que significa uma lista dos serviços usados
    • Créditos de colaborador
    • Links para as próximas etapas e recursos relacionados, como guias e arquiteturas relacionadas

  • Solução de exemplo: as soluções de exemplo são cargas de trabalho de exemplo com arquiteturas "médias". Elas guiam os leitores por meio do processo de desenvolvimento de soluções para problemas específicos nas implementações do Dynamics 365. As soluções de exemplo fornecem diretrizes de arquitetura acionáveis baseadas em exemplos de clientes reais. A meta é reduzir a curva de aprendizado dos clientes informando a história de outro cliente que teve o mesmo percurso. Eles incluem as seções do modelo Ideia de Solução e adicionam as seguintes seções:

    • Alternativas, outros serviços que podem ser conectados à arquitetura em seu lugar
    • Considerações, diretrizes que mapeiam para nossa estrutura Success by Design e, opcionalmente, incluem uma implantação

  • Padrão de design: os padrões de design do Dynamics 365 abordam desafios específicos em implementações e se baseiam em um cenário ou prática recomendada específica. Use este modelo para capturar um padrão de processo empresarial. Como alternativa, use o modelo do Word em dynamics365patternspractices/templates/business-processes.

Colaborações no processo empresarial

O termo processo empresarial abrange uma ampla variedade de atividades ou tarefas estruturadas, geralmente em sequência, para obter uma meta organizacional predeterminada. O termo também pode se referir aos efeitos cumulativos de todas as etapas que estão progredindo em direção a uma meta de negócios. Os processos empresariais são específicos das soluções que incluem o Dynamics 365. Acreditamos que esse novo tipo de conteúdo cria uma estrutura que ajuda clientes e parceiros a estar mais bem preparados para adotar o Dynamics 365. Cada processo empresarial inclui um diagrama de um fluxo de processo empresarial padrão. As seções do documento descrevem as etapas de configuração e as entidades de dados usadas em cada uma das etapas. Cada etapa vincula à página relevante na documentação do produto, e todos os documentos têm links para as próximas etapas e recursos relacionados para ajudar os leitores ao longo de sua jornada de aprendizado.

Estruturamos os processos empresariais em um catálogo. O catálogo de processos empresariais é uma pasta de trabalho do Excel que utilizamos na Microsoft para organizar e priorizar nosso trabalho na documentação de processo empresarial. O formato é Excel porque facilita a classificação e a filtragem das entradas. Acreditamos também que nossos parceiros podem usar a pasta de trabalho do Excel para organizar suas jornadas de integração, seus projetos de implementação e seus próprios processos empresariais.

Baixe a versão mais recente do catálogo de https://aka.ms/BusinessProcessCatalog.

Observação

Se você desejar colaborar com os processos empresariais, registre seu trabalho antes de começar a fim de reduzir o risco de outra pessoa trabalhar no mesmo processo empresarial que você. Para registrar seu trabalho, envie um problema do GitHub em https://github.com/microsoft/dynamics365patternspractices/issues.

O que o catálogo contém

O catálogo define quatro níveis de conteúdo:

  1. Processos de ponta a ponta

    Identificamos 15 cenários de ponta a ponta. Descrevemos os cenários em termos empresariais, não em termos de tecnologia de software.

    Para cada processo de ponta a ponta, o artigo introdutório descreve nossa opinião sobre o processo de ponta a ponta. Listamos os principais stakeholders e como o Dynamics 365 ajuda o processo de ponta a ponta. Também é possível fornecer uma visão geral, juntamente com um diagrama do fluxo de processo empresarial, de como o processo de ponta a ponta interage com outros processos de ponta a ponta. A introdução lista os pré-requisitos para a implementação de uma solução para dar suporte ao processo de ponta a ponta.

  2. Áreas do processo empresarial

    Cada cenário de ponta a ponta abrange duas ou mais áreas de processo empresarial. Esse nível é apenas uma forma de agrupar os processos empresariais para facilitar a pesquisa e a navegação. Na maioria dos casos, as áreas do processo empresarial são separadas por funções ou departamentos de trabalho principais em uma organização. Atualmente, o catálogo define mais de 90 áreas de processo empresarial.

  3. Processos empresariais

    O termo processo empresarial abrange uma ampla variedade de atividades ou tarefas estruturadas, geralmente em sequência, para obter uma meta organizacional predeterminada. O termo também pode se referir aos efeitos cumulativos de todas as etapas que estão progredindo em direção a uma meta de negócios. Cada processo empresarial descreve uma função ou um processo ao qual o Dynamics 365 oferece suporte. Até agora, identificamos quase 700 processos empresariais. Alguns deles se aplicam a um único aplicativo Dynamics 365, e a documentação do aplicativo talvez já descreva o processo. Ao coletar todos os processos empresariais aqui no guia, esperamos fornecer um único ponto de entrada com links para o conteúdo relevante específico do produto.

  4. Padrões

    No Dynamics 365, os padrões são configurações repetíveis que oferecem suporte a um processo empresarial específico. Eles incluem os casos de uso, cenários e setores mais comuns. Geralmente, há várias maneiras de implementar o Dynamics 365 para atender aos seus requisitos de negócios. Nossa meta com os padrões é fornecer uma linha de base para sua implementação. Identificamos mais de 2000 padrões e esperamos que o número cresça significativamente ao longo do tempo.

Obtenha uma introdução adicional ao catálogo de processos empresariais em Sobre o guia de processos empresariais.

Envie sua colaboração

Internamente na Microsoft, estamos trabalhando muito para converter notas internas, anos de experiência e vários documentos nas diretrizes de processos empresariais. As colaborações da comunidade são muito bem-vindas.

O repositório do GitHub contém modelos do Word que podem ser usados para capturar sua colaboração. Todos os modelos do Word estão na pasta /templates/business-processes. A pasta também contém um modelo do PowerPoint que pode ajudá-lo a criar os diagramas necessários. Como alternativa, use o Visio ou outro designer.

Quando estiver pronto para enviar um novo artigo, preencha nosso formulário de envio e anexe o(s) arquivo(s).

Opcionalmente, adicione seu perfil do LinkedIn para que você possa ser listado como o autor original.

Reconhecimento do colaborador

A plataforma do Microsoft Learn mostra os colaboradores internos e externos na parte superior de cada artigo se tiverem enviado sua contribuição por meio do GitHub. Algumas pessoas contribuem de outras maneiras, portanto podemos adicionar a seção Colaboradores no final do artigo.

A seção opcional Colaboradores lista os principais colaboradores com seu nome e um link para o perfil do LinkedIn ou outro perfil, se eles forneceram um. A captura de tela a seguir é uma versão anônima da seção Colaboradores em um artigo do Centro de Arquitetura do Azure.

Captura de tela de um exemplo da seção Colaboradores, mostrando o autor principal e mais três colaboradores listados com links para seus perfis do LinkedIn.

Veja como é em Markdown:

## Contributors

*This article is maintained by Microsoft. It was originally written by the following contributors.*

Principal author:

* [Author's Name](https://www.linkedin.com/in/author-account/) | Author's job title or similar  

Other contributors:

* [Contributor's Name](https://www.linkedin.com/in/contributor-account/) | Contributor's job title or similar  
* [Contributor's Name](https://www.linkedin.com/in/contributor-account/) | Contributor's job title or similar

Ser listado como um colaborador dessa forma é opcional. Na Microsoft, é recomendável usar a seção Colaboradores se os colaboradores externos enviarem novos conteúdos, como arquiteturas de referência e padrões de design, por outros meios que não sejam o GitHub.