参与 Teams 文档

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

设置工作区

  • 在VS Code内安装:
  1. 选择侧边活动栏上的“扩展”图标,或使用 视图 => Extensions 命令或 Ctrl+Shift+X,然后搜索 Microsoft Docs创作包
  2. 选择“安装”。
  3. 安装后, 安装 更改 管理 齿轮按钮。

查看Microsoft Docs参与者指南

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

Microsoft 写作、风格和内容指南

  • Microsoft 写作风格指南:Microsoft 写作风格指南是一种全面的技术写作资源,反映了 Microsoft 的现代语音和风格方法。 若要轻松参考,请将此联机指南添加到浏览器的 收藏夹 菜单。

  • 编写开发人员内容:Teams 特定内容面向对编程概念和流程有基本了解的开发人员受众。 务必以引人注目的方式提供清晰、技术上准确的信息,同时保持 Microsoft 的音调和风格。

  • 编写分步说明:应用和交互式体验是开发人员了解 Microsoft 产品和技术的好方法。 以渐进式格式呈现复杂或简单的过程是自然的,并且用户友好。

MarkDown 参考

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

文件路径

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

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

重要

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

若要引用 不属于 Teams 平台文档集 Microsoft Docs库文章:
 ✔ 使用以正斜杠开头的相对路径。
 ✔ 不要包括文件扩展名。
例如:/docset/address-to-file-location —> 使用 Microsoft Graph API 与 Microsoft Teams

若要引用Microsoft Docs库之外的页面(如 GitHub),请使用完整的 https 文件路径。

代码示例和代码片段

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

后续步骤

另请参阅