Contribuir com a documentação do Teams
A documentação do Teams faz parte da biblioteca de documentação técnica do Microsoft Learn . O conteúdo é organizado em grupos chamados docsets, cada um representando um grupo de documentos relacionados gerenciados como uma única entidade. Os artigos no mesmo conjunto de documentos têm a mesma extensão de caminho do URL após learn.microsoft.com. Por exemplo, /learn.microsoft.com/microsoftteams/... é o início do caminho do arquivo do conjunto de documentos do Teams. Os artigos do Teams são escritos na sintaxe de Markdown e hospedados no GitHub.
Configurar seu espaço de trabalho
- Instalar Git.
- Instalar Microsoft Visual Studio Code (VS Code).
- Instalar Docs Authoring Pack diretamente do VS Code Marketplace.
ou
- Instalar dentro VS Code:
- Selecione o ícone Extensões na barra de atividade lateral ou utilize o comando Ver => Extensões ou Ctrl+Shift+X e procure Pacote de Criação do Docs.
- Selecionar Instalar.
- Após a instalação, o Instalar muda para o botão de engrenagem Gerenciar.
Rever o guia de contribuidor do Microsoft Docs
O guia de contribuidores fornece direções para criar, publicar e atualizar conteúdos técnicos na plataforma Microsoft Learn .
Guias de escrita, estilo e conteúdo da Microsoft
Guia de Estilo de Escrita da Microsoft: o Guia de Estilo de Escrita da Microsoft é um recurso abrangente para escrita técnica e reflete a abordagem moderna da Microsoft para voz e estilo. Para facilitar a referência, adicione este guia online ao menu Favoritos do navegador.
Escrever conteúdo do desenvolvedor: o conteúdo específico do Teams é destinado a um público-alvo de desenvolvedores com uma compreensão fundamental dos conceitos e processos de programação. É importante que forneça informações claras e tecnicamente precisas de forma apelativa, mantendo o tom e o estilo da Microsoft.
Escrevendo instruções passo a passo: experiências interativas e aplicadas são uma ótima maneira para os desenvolvedores aprenderem sobre produtos e tecnologias da Microsoft. Apresentar procedimentos complexos ou simples em um formato progressivo é natural e amigável.
Referência de MarkDown
As páginas do Microsoft Learn são escritas na sintaxe MarkDown e analisadas através de um motor Markdig. Para obter mais informações sobre tags específicas e convenções de formatação, consulte a referência do Docs Markdown.
Caminhos de Arquivo
Ao utilizar caminhos relativos e criar ligações para outros conjuntos de documentos, é importante definir um caminho de ficheiro válido para hiperligações na sua documentação. Seu build será bem-sucedido no GitHub somente se o caminho do arquivo estiver correto ou válido.
Para obter mais informações sobre hiperlinks e caminhos de arquivo, consulte use links na documentação.
Importante
Para fazer referência a um artigo que faz parte do conjunto de documentos da plataforma Teams:
✔ Utilize um caminho relativo sem uma barra à frente.
✔ Inclua a extensão de ficheiro Markdown.
Ex.: diretório/diretório/caminho para o artigo.md —>Criar uma aplicação para o Microsoft Teams
Para referenciar um artigo do Microsoft Learn que não faz parte do conjunto de documentos da plataforma teams:
✔ Utilize um caminho relativo que comece com uma barra.
✔ Não inclua a extensão de ficheiro.
Por exemplo: /docset/address-to-file-location —>Utilize a Microsoft Graph API para trabalhar com o Microsoft Teams
Para referenciar uma página fora do Microsoft Learn, como o GitHub, utilize o caminho completo https do ficheiro.
Exemplos de código e snippets
Os exemplos de código desempenham uma função importante para usar APIs e SDKs com eficiência. Exemplos de código bem apresentados podem comunicar como as coisas funcionam mais claramente do que apenas texto descritivo e informações instrucionais. Seus exemplos de código devem ser precisos, concisos, bem documentados e amigáveis ao leitor. O código que é fácil de ler deve ser fácil de entender, testar, depurar, manter, modificar e estender. Para obter mais informações, veja como incluir código num artigo.