Como contribuir para a documentação do SQL Server

2025-05-28

Aplica-se a:Servidor SQLBanco de Dados SQL do AzureAzure Synapse Analytics Sistema de plataforma de análise (PDW)

Qualquer pessoa pode contribuir para a documentação do SQL Server. Isso inclui corrigir erros de digitação, sugerir melhores explicações e melhorar a precisão técnica. Este artigo explica como começar com contribuições de conteúdo e como funciona o processo.

Há dois fluxos de trabalho principais que você pode usar para contribuir:

Fluxo de trabalho	Descrição
Editar no seu navegador	Bom para pequenas e rápidas edições de qualquer artigo.
Edite localmente com ferramentas	Bom para edições mais complexas, edições envolvendo vários artigos e contribuições frequentes.

A equipe de conteúdo do Data Docs valida todas as contribuições públicas para precisão técnica e consistência.

Editar no seu navegador

Você pode fazer edições simples no conteúdo do SQL Server em seu navegador e, em seguida, enviá-las à Microsoft. Para obter mais informações, consulte a visão geral do guia do colaborador.

As etapas a seguir resumem o processo:

Na página sobre a qual você tem comentários, selecione o ícone de lápis no canto superior direito.
Na página seguinte, selecione o ícone de lápis no canto superior direito. Se esse ícone não aparecer, talvez seja necessário fazer login na sua conta do GitHub primeiro.
Na página seguinte, na janela Editar texto do arquivo , faça suas edições diretamente no texto que deseja alterar. Se precisar de ajuda para formatar o texto novo ou alterado, consulte o Guia de Referência de Markdown.
Depois de fazer as edições, em Confirmar alterações:
1. Na primeira caixa de texto, insira uma breve descrição da alteração feita.
2. Na caixa Adicionar uma descrição estendida opcional , forneça uma breve explicação da alteração.
Selecione Propor alteração de arquivo.
Na página Comparando alterações , selecione Criar pull request.
Na página Abrir uma solicitação pull , selecione Create pull request.

O GIF a seguir demonstra o processo de ponta a ponta para enviar alterações em seu navegador:

Edite localmente com ferramentas

Outra opção de edição é bifurcar os repositórios sql-docs ou azure-docs e cloná-los localmente na sua máquina. Em seguida, você pode usar um editor de Markdown e um cliente git para enviar as alterações. Esse fluxo de trabalho é bom para edições mais complexas ou que envolvem vários arquivos. Também é bom para colaboradores frequentes da documentação técnica da Microsoft.

Para contribuir com esse método, consulte os seguintes artigos:

Se você enviar uma solicitação pull com alterações significativas na documentação, receberá um comentário no GitHub solicitando que você envie um Contrato de Licença de Contribuição (CLA) on-line. Deve preencher o formulário online antes de o seu pedido de pull poder ser aceite.

Reconhecimento

Se suas alterações forem aceitas, você será reconhecido como um colaborador na parte superior do artigo.

Selecione o link de contribuidores e você pode ver a lista de colaboradores com mais detalhes.

Captura de tela da caixa de diálogo de reconhecimento de contribuição de conteúdo.

Visão geral: repositório sql-docs

Esta seção fornece orientações adicionais sobre trabalhar no sql-docs repositório.

Importante

As informações nesta seção são específicas de sql-docs. Se você estiver editando um artigo SQL na documentação do Azure, consulte o Leiame do repositório azure-docs no GitHub.

O repositório sql-docs usa várias pastas padrão para organizar o conteúdo.

Pasta de Arquivos	Descrição
documentos	Contém todo o conteúdo publicado do SQL Server. As subpastas organizam logicamente diferentes áreas do conteúdo.
docs/inclui	Contém arquivos de inclusão. Esses arquivos são blocos de conteúdo que podem ser incluídos em um ou mais outros artigos.
`./media`	Cada pasta pode ter uma `media` subpasta para imagens de artigos. A `media` pasta, por sua vez, tem subpastas com o mesmo nome dos artigos em que a imagem aparece. As imagens devem ser `.png` arquivos com todas as letras minúsculas e sem espaços.
`TOC.yml`	Um ficheiro de índice. Cada subpasta tem a opção de usar um `TOC.yml` arquivo.

Aplica-se a inclui

Cada artigo do SQL Server contém um applies-to arquivo include após o título. Isso indica a quais áreas ou versões do SQL Server o artigo se aplica.

Considere o seguinte exemplo de Markdown que extrai o applies-to-version/sql-asdb-asdbmi-asa-pdw-fabricsqldb.md arquivo include.

[!INCLUDE [SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW) SQL database in Microsoft Fabric](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw-fabricsqldb.md)]

Isso adiciona o seguinte texto ao topo do artigo:

Para encontrar o arquivo de inclusão correto para o seu artigo, use as seguintes dicas:

Para obter uma lista de ficheiros de inclusão comumente usados, consulte ficheiros de inclusão do SQL Server para versionamento e aplicabilidade.
Veja outros artigos que abordam o mesmo recurso ou uma tarefa relacionada. Se você editar esse artigo, poderá copiar o Markdown para o link applies-to include (você pode cancelar a edição sem enviá-lo).
Pesquise no diretório docs/includes por arquivos que contenham o texto applies-to. Você pode usar o botão Localizar no GitHub para filtrar rapidamente. Selecione o arquivo para ver como ele é renderizado.
Preste atenção ao padrão de nomes. Se o nome contiver vários x caracteres na string, eles geralmente são marcadores de posição indicando a falta de suporte para um serviço. Por exemplo, appliesto-xx-xxxx-asdw-xxx-md.md indica suporte apenas para o Azure Synapse Analytics, porque apenas asdw está escrito, enquanto os outros campos são preenchidos com o x caractere.
Alguns incluem especificar um número de versão, como tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Use esses arquivos de inclusão somente quando souber que o recurso foi introduzido com uma versão específica do SQL Server.

Recursos do contribuidor

Sugestão

Se você tiver comentários sobre o produto em vez de comentários sobre a documentação, forneça comentários sobre o produto SQL Server aqui.

Explore o repositório sql-docs no GitHub.

Encontre um artigo, envie uma alteração e ajude a comunidade do SQL Server.

Obrigado.

Partilhar via