参与 Teams 文档

项目
08/30/2023

Teams 文档是 Microsoft Learn 技术文档库的一部分。内容分为称为 docsets 的组，每个组表示作为单个实体管理的一组相关文档。同一文档集中的项目在之后 learn.microsoft.com具有相同的 URL 路径扩展。例如，/learn.microsoft.com/microsoftteams/...是 Teams 文档集文件路径的开头。 Teams 文章以 Markdown 语法编写，并托管在 GitHub 上。

设置工作区

安装 Git。
安装 Microsoft Visual Studio代码（VS Code）。
直接从 VS Code 市场安装 Docs Authoring Pack。
或

在VS Code内安装：

选择侧边活动栏上的 “扩展”图标 ，或使用 “视图 => 扩展” 命令或 Ctrl+Shift+X，然后搜索 “Docs 创作包”。
选择“安装”。
安装后，安装更改管理齿轮按钮。

查看Microsoft Docs 参与者指南

参与者指南提供了在 Microsoft Learn 平台上创建、发布和更新技术内容的方向。

Microsoft 写作、风格和内容指南

Microsoft 写作风格指南：Microsoft 写作风格指南是一种全面的技术写作资源，反映了 Microsoft 的现代语音和风格方法。若要轻松参考，请将此联机指南添加到浏览器的 收藏夹 菜单。
编写开发人员内容：Teams 特定内容面向对编程概念和流程有基本了解的开发人员受众。必须以引人注目的方式提供清晰、技术上准确的信息，同时保持 Microsoft 的语气和风格，这一点很重要。
编写分步说明：应用和交互式体验是开发人员了解 Microsoft 产品和技术的好方法。以渐进式格式呈现复杂或简单的过程是自然的，并且用户友好。

MarkDown 参考

Microsoft Learn 页面采用 MarkDown 语法编写，并通过 Markdig 引擎进行分析。有关特定标记和格式设置约定的详细信息，请参阅 Docs Markdown 参考。

文件路径

使用相对路径并创建指向其他文档集的链接时，请务必为文档中的超链接设置有效的文件路径。仅当文件路径正确或有效时，GitHub 上的生成才会成功。

有关超链接和文件路径的详细信息，请参阅使用文档中的链接。

重要

若要引用 Teams 平台文档集 一部分的文章，请执行以下操作：
✔ 使用不带前导正斜杠的相对路径。
✔ 包括 Markdown 文件扩展名。
例如：父目录/目录/路径到 article.md —>为 Microsoft Teams 生成应用

引用 不属于 Teams 平台文档集的 Microsoft Learn 文章：
✔ 使用以正斜杠开头的相对路径。
✔ 不要包含文件扩展名。
例如：/docset/address-to-file-location —>使用 Microsoft 图形 API与 Microsoft Teams 配合使用

若要引用 Microsoft Learn 外部的页面（如 GitHub），请使用完整 https 文件路径。

代码示例和代码片段

代码示例对于有效使用 API 和 SDK 起着重要作用。与描述性文本和说明性信息相比，展示良好的代码示例可以更清楚地传达工作方式。代码示例必须准确、简洁、记录良好且易于阅读。易于阅读的代码必须易于理解、测试、调试、维护、修改和扩展。有关详细信息，请参阅如何在文章中包含代码。

后续步骤

Microsoft Teams 应用疑难解答