SQL Server のドキュメントに投稿する方法How to contribute to SQL Server Documentation

適用対象: SQL Server Azure SQL Database Azure Synapse Analytics (SQL Data Warehouse) Parallel Data Warehouse

誰でも SQL Server のドキュメントに投稿できます。Anyone can contribute to SQL Server documentation. 投稿には、入力ミスの修正、もっとよい説明の提案、技術的正確さの改善などがあります。This includes correcting typos, suggesting better explanations, and improving technical accuracy. この記事では、コンテンツへの投稿の概要とプロセスについて説明します。This article explains how to get started with content contributions and how the process works.

2 つの主要なワークフローを使って投稿することができます。There are two main workflows you can use to contribute:

ワークフローWorkflow 説明Description
ブラウザーで編集するEdit in your browser 任意の記事のちょっとした編集を簡単に行うのに適しています。Good for small, quick edits of any article.
ツールを使ってローカルに編集するEdit locally with tools 複雑な編集、複数の記事が関係する編集、および docs.microsoft.com への頻繁な投稿に適しています。Good for more complex edits, edits involving multiple articles, and frequent contributions to docs.microsoft.com.

公開されるすべての投稿は、SQL コンテンツ チームによって技術的正確さと一貫性が検証されます。All public contributions are validated by the SQL content team for technical accuracy and consistency.

ブラウザーで編集するEdit in your browser

お使いのブラウザーで SQL Server のコンテンツに簡単な編集を加え、Microsoft に送信することができます。You can make simple edits to SQL Server content in your browser and then submit them to Microsoft. 詳細については、Microsoft Docs 共同作成者ガイドの概要のページを参照してください。For more information, you can see the Microsoft Docs contributor guide overview.

次の手順は、このプロセスをまとめたものです。The following steps summarize the process:

  1. フィードバックがあるページで、右上の [編集] リンクを選択します。On the page you have feedback about, select the Edit link at the top right.
  2. 次のページで、右上の鉛筆アイコンを選択します。On the next page, select the Pencil icon at the top right.
  3. 次のページの [Edit file](ファイルの編集) テキスト ウィンドウで、変更するテキストを直接編集します。On the next page, in the Edit file text window, make your edits directly to the text you want to change. 新規または変更されたテキストの書式設定に関するヘルプが必要な場合は、「Markdown Cheatsheet」(マークダウンのカンニング ペーパー) を参照してください。If you need help with formatting the new or changed text, see the Markdown Cheatsheet.
  4. 編集が完了したら、 [Commit changes](変更のコミット) で次の手順を実行します。After you've made your edits, under Commit changes:
    1. 最初のテキスト ボックスに、行った変更の簡単な説明を入力します。In the first text box, enter a brief description of the change you've made.
    2. [Add an optional extended description](省略可能な長い説明を追加する) ボックスに、変更の簡単な説明を入力します。In the Add an optional extended description box, provide a brief explanation of your change.
  5. [Propose file change](ファイルの変更の提案) を選択します。Select Propose file change.
  6. [Comparing changes](変更の比較) ページで、 [Create pull request](プル要求の作成) を選択します。On the Comparing changes page, select Create pull request.
  7. [Open a pull request](プル要求を開く) ページで、 [Create pull request](プル要求の作成) を選択します。On the Open a pull request page, select Create pull request.

次の GIF は、お使いのブラウザーで変更を送信するためのエンドツーエンド プロセスを示しています。The following GIF demonstrates the end-to-end process for submitting changes in your browser:

SQL ドキュメントの編集

ツールを使ってローカルに編集するEdit locally with tools

もう 1 つの編集オプションは、sql-docs または azure-docs リポジトリをフォークして、お使いのコンピューターにローカルに複製します。Another editing option is to fork the sql-docs or azure-docs repositories and clone it locally to your machine. その後、Markdown エディターと git クライアントを使って、変更を送信することができます。You can then use a Markdown editor and a git client to submit the changes. このワークフローは、複雑で複数のファイルが関係する編集に適しています。This workflow is good for edits that are more complex or involve multiple files. また、docs.microsoft.com に頻繁に投稿する場合にも適しています。It is also good for frequent contributors to docs.microsoft.com.

この方法で投稿する場合は、次の記事を参照してください。To contribute with this method, see the following articles:

ドキュメントを大幅に変更する pull request を送信する場合は、オンライン貢献者使用許諾契約書 (CLA) の提出を求める GitHub のコメントを受け取ります。If you submit a pull request with significant changes to documentation, you will get a comment in GitHub asking you to submit an online Contribution License Agreement (CLA). オンライン フォームを提出してからでないと、pull request は受け付けられません。You must complete the online form before your pull request can be accepted.

認識Recognition

変更が受け付けられると、記事の上部で共同作成者として認識されます。If your changes are accepted, you are recognized as a contributor at the top of the article.

コンテンツへの投稿の認識

sql-docs の概要sql-docs overview

このセクションでは、sql-docs リポジトリでの作業に関するその他のガイダンスを提供します。This section provides some additional guidance on working in the sql-docs repository.

重要

このセクションの情報は、sql-docs に固有のものです。Azure のドキュメントに含まれる SQL の記事を編集する場合は、GitHub で azure-docs リポジトリの Readme を参照してください。The information in this section is specific to sql-docs. If you are editing a SQL article in the Azure documentation, see the Readme for the azure-docs repository on GitHub.

sql-docs リポジトリでは、複数の標準フォルダーを使ってコンテンツが整理されています。The sql-docs repository uses several standard folders to organize the content.

FolderFolder 説明Description
docsdocs 公開されたすべての SQL Server コンテンツが格納されています。Contains all published SQL Server content. サブフォルダーには、異なる分野のコンテンツが論理的にまとめられています。Subfolders logically organize different areas of the content.
docs/includesdocs/includes インクルード ファイルが格納されています。Contains include files. これらのファイルは、他のトピックに含めることのできるコンテンツのブロックです。These files are blocks of content that can be included in one or more other topics.
./media./media 各フォルダーには、記事の画像用に 1 つの media サブフォルダーが含まれる場合があります。Each folder can have one media subfolder for article images. media フォルダーには、画像が表示されるトピックと同じ名前のサブフォルダーがあります。The media folder in turn has subfolders with the same name as the topics that the image appears in. 画像は .png ファイルで、すべて小文字のスペースを含まない名前になっている必要があります。Images should be .png files with all lower-case letters and no spaces.
TOC.MDTOC.MD 目次のファイルです。A table-of-contents file. 各サブフォルダーでは、1 つの TOC.MD ファイルを使うことができます。Each subfolder has the option of using one TOC.MD file.

applies-to インクルードApplies-to includes

SQL Server の各記事には、タイトルの後に applies-to インクルード ファイルが含まれています。Each SQL Server article contains an applies-to include file after the title. これは、その記事が適用される SQL Server の領域またはバージョンを示します。This indicates what areas or versions of SQL Server the article applies to.

appliesto-ss-asdb-asdw-pdw-md.md インクルード ファイルの Markdown の例を次に示します。Consider the following Markdown example that pulls in the appliesto-ss-asdb-asdw-pdw-md.md include file.

[!INCLUDE[SQL Server Azure SQL Database Synapse Analytics PDW ](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

このインクルード ファイルにより、記事の上部に次のテキストが追加されます。This adds the following text at the top of the article:

適用対象のテキスト

記事の適切な applies-to インクルード ファイルを探すには、次のヒントを参考にしてください。To find the correct applies-to include file for your article, use the following tips:

  • 一般的に使用されるインクルードの一覧は、SQL Server のバージョンと applies-to インクルード ファイルに関するページを参照してください。For a list of commonly used includes, see SQL Server version and applies-to include files.
  • 同じ機能または関連タスクをカバーしている他の記事を探します。Look at other articles that cover the same feature or a related task. その記事を編集する場合は、applies-to インクルード リンクの Markdown をコピーできます (送信しないで編集をキャンセルできます)。If you edit that article, you can copy the Markdown for the applies-to include link (you can cancel the edit without submitting it).
  • docs/includes ディレクトリで、"applies-to" というテキストを含むファイルを探します。Search the docs/includes directory for files containing the text "applies-to". GitHub の [Find] ボタンを使ってすばやくフィルター処理できます。You can use the Find button in github to quickly filter. ファイルをクリックして、どのようにレンダリングされるかを確認します。Click on the file to see how it is rendered.
  • 名前付けの規則に注意してください。Pay attention to the naming convention. 名前に "x" が含まれる場合は、通常、サービスのサポートがないことを示すプレースホルダーです。If there are x's in the name, they are usually placeholders indicating the lack of support for a service. たとえば、appliesto-xx-xxxx-asdw-xxx-md.md は、asdw だけが明示され、他のフィールドは "x" になっているので、Azure Synapse Analytics のみのサポートであることを示しています。For example, appliesto-xx-xxxx-asdw-xxx-md.md indicates support for only Azure Synapse Analytics, because only asdw is spelled out, whereas the other fields have x's.
  • tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md のようにバージョン番号が指定されていることもあります。Some includes specify a version number, such as tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. SQL Server の特定のバージョンで機能が導入されたことがわかっている場合は、そのインクルードだけを使ってください。Only use these includes when you know the feature was introduced with a specific version of SQL Server.

共同作成者のリソースContributor resources

ヒント

ドキュメントに関するフィードバックではなく製品のフィードバックの場合は、こちらで SQL Server 製品に関するフィードバックを提供してください。If you have product feedback rather than documentation feedback, provide feedback on the SQL Server product here.

次のステップNext steps

GitHub で sql-docs リポジトリを調べます。Explore the sql-docs repository on GitHub.

記事を探し、変更内容を送信して、SQL Server コミュニティに投稿します。Find an article, submit a change, and help the SQL Server community.

よろしくお願いいたします。Thank you!