Contribuindo para a documentação do Microsoft TeamsContributing to Microsoft Teams documentation

A documentação do teams é parte da biblioteca de documentação técnica do Microsoft docs .Teams documentation is part of the Microsoft Docs technical documentation library. O conteúdo é organizado em grupos chamados docsets, cada um deles representando um grupo de documentos relacionados gerenciados como uma entidade única.The content is organized into groups called docsets, each representing a group of related documents managed as a single entity. Os artigos no mesmo docset têm a mesma extensão de caminho de URL após docs . Microsoft.com.Articles in the same docset have the same URL path extension after docs.microsoft.com. Por exemplo, /docs.microsoft.com/microsoftteams/... é o início do caminho de arquivo do teams docset.For example, /docs.microsoft.com/microsoftteams/... is the beginning of the Teams docset file path. Os artigos do teams são escritos em sintaxe de redução e hospedados no GitHub.Teams articles are written in MarkDown syntax and hosted on GitHub.

Configurar seu espaço de trabalhoSet up your workspace

  • Instalar de dentro do VS Code:Install from within VS Code:
  1. Selecione o ícone de extensões na barra de atividades do lado ou use o comando Exibir => Extensions (Ctrl + Shift + X) e procure o pacote de criação de docs (Microsoft).Select the Extensions icon on the side activity bar or use the View => Extensions command (Ctrl+Shift+X) and search for the Docs Authoring Pack (Microsoft).
  2. Selecione o botão instalar .Select the Install button.
  3. Depois que a instalação for concluída, o botão instalar mudará para o botão gerenciar engrenagem.Once installation is complete, the Install button will change to the Manage gear button.

Analisar o guia de colaboradores de docs da MicrosoftReview the Microsoft Docs Contributors Guide

O guia contribuidores oferece orientações para criar, publicar e atualizar o conteúdo técnico no Microsoft/docs. Confira tambémo estilo de docs e início rápido de voz .The contributors guide offers direction for creating, publishing, and updating technical content on Microsoft /docs. See also, Docs style and voice quick start .

Guias de escrita, estilo e conteúdo da MicrosoftMicrosoft Writing, Style, and Content Guides

  • Guia de estilo de escrita da Microsoft.Microsoft Writing Style Guide. Considere adicionar este guia online ao menu favoritos do seu navegador.Consider adding this online guide to your browser's Favorites menu. É um recurso abrangente para a escrita técnica de hoje e reflete a abordagem moderna da Microsoft para voz e estilo.It is a comprehensive resource for today's technical writing and reflects Microsoft's modern approach to voice and style.

  • Escrever o conteúdo do desenvolvedor.Writing developer content. O conteúdo específico de equipes é direcionado a um público-alvo de desenvolvedor com uma compreensão fundamental de conceitos e processos de programação.Teams-specific content is aimed at a developer audience with a fundamental understanding of programming concepts and processes. É importante que você forneça informações claras, tecnicamente precisas, de forma atraente, mantendo o Tom e o estilo da Microsoft.It is important that you provide clear, technically-accurate information in a compelling manner while maintaining Microsoft's tone and style.

  • Escrever instruções passo a passo.Writing step-by-step instructions. As experiências aplicadas e interativas são uma ótima maneira de os desenvolvedores aprenderem sobre produtos e tecnologias da Microsoft.Applied and interactive experiences are a great way for developers to learn about Microsoft products and technologies. A apresentação de procedimentos complexos ou simples em um formato progressivo é natural e amigável.Presenting complex or simple procedures in a progressive format is natural and user-friendly.

Referência de reduçãoMarkDown reference

As páginas de docs da Microsoft são escritas em sintaxe de redução e analisadas por meio de um mecanismo do Markdig .Microsoft Docs pages are written in MarkDown syntax and parsed through a Markdig engine. Confira referência de redução de docs para marcas específicas e convenções de formatação.Please see Docs Markdown reference for specific tags and formatting conventions.

Caminhos de arquivoFile Paths

A definição de um caminho de arquivo válido para hiperlinks na documentação pode ser um desafio, especialmente quando se usa caminhos relativos e cria links para outros docsets.Setting a valid file path for hyperlinks in your documentation can be a challenge, especially when using relative paths and creating links to other docsets. Sua compilação não terá êxito no GitHub se o caminho do arquivo estiver incorreto ou inválido.Your build won't succeed on GitHub if the file path is incorrect or invalid.

Para obter mais informações sobre hiperlinks e caminhos de arquivo, consulte use links na documentação.For more information on hyperlinks and file paths, please see Use links in documentation.

Importante

Para fazer referência a um artigo que faz parte da plataforma de docset do Microsoft Teams:To reference an article that is part of the Teams platform docset:
 ✔ usar um caminho relativo sem uma barra de avanço à esquerda. ✔ Use a relative path without a leading forward slash.
 ✔ incluir a extensão do arquivo de redução. ✔ Include the Markdown file extension.
Ex: diretório pai/diretório/caminho-para-article. MD — >[Building an app for Microsoft Teams](../concepts/building-an-app.md)Ex: parent directory/directory/path-to-article.md —> [Building an app for Microsoft Teams](../concepts/building-an-app.md)

Para fazer referência a um / artigo da biblioteca de docs da Microsoft () que não faz parte da plataforma do teams docset:To reference a Microsoft Docs library (/) article that isn't part of the Teams platform docset:
 ✔ use um caminho relativo que comece com uma barra. ✔ Use a relative path that begins with a forward slash.
 ✔ não inclua a extensão de arquivo. ✔ Don't include the file extension.
Ex: /docset/address-to-file-location — >[Use the Microsoft Graph API to work with Microsoft Teams](/graph/api/resources/teams-api-overview)Ex: /docset/address-to-file-location —> [Use the Microsoft Graph API to work with Microsoft Teams](/graph/api/resources/teams-api-overview)

Exemplos de código e trechosCode Samples and Snippets

Exemplos de código desempenham um papel importante para ajudar os desenvolvedores a usarem APIs e SDKs com êxito.Code samples play an important role in helping developers successfully use APIs and SDKs. Exemplos de código bem apresentados podem comunicar como as coisas funcionam de forma mais clara do que o texto descritivo e informações instrutivas.Well-presented code samples can communicate how things work more clearly than descriptive text and instructional information alone. Seus exemplos de código devem ser precisos, conciso, bem documentados e, mais importante, amigáveis para leitores.Your code samples should be accurate, concise, well-documented, and, most importantly, reader-friendly. O código que é fácil de ler também é fácil de entender, testar, depurar, manter, modificar e estender.Code that is easy-to-read is also easy to understand, test, debug, maintain, modify, and extend. Confira como incluir código em docs. Para obter dicas de legibilidade, Confira também Cutting Edge: dicas de legibilidade do código-fonte.See How to include code in docs. For readability tips, please see also Cutting Edge : Source Code Readability Tips.