Contribuir a este contenido

Teams documentación forma parte de la biblioteca de documentación técnica de Microsoft Docs. El contenido se organiza en grupos denominados docsets, cada uno que representa un grupo de documentos relacionados administrados como una sola entidad. Los artículos del mismo conjunto de documentos tienen la misma extensión de ruta de acceso url después de docs.microsoft.com. Por ejemplo, /docs.microsoft.com/microsoftteams/... es el principio de la ruta Teams de archivo docset. Teams artículos se escriben en la sintaxis de Markdown y se hospedan en GitHub.

Configurar el área de trabajo

  • Instalar en VS Code:
  1. Seleccione el icono Extensiones en la barra de actividad lateral o use el comando Ver = > Extensiones o Ctrl+Mayús+X y busque Microsoft Docs Authoring Pack.
  2. Seleccione Instalar.
  3. Después de la instalación, el botón Instalar cambia al botón Administrar engranaje.

Revisar la Guía de colaboradores de Microsoft Docs

La guía de colaboradores proporciona instrucciones para crear, publicar y actualizar contenido técnico en la plataforma de Microsoft Docs.

Guías de contenido, estilo y escritura de Microsoft

  • Microsoft Writing Style Guide: Microsoft Writing Style Guide es un recurso completo para la escritura técnica y refleja el enfoque moderno de Microsoft para la voz y el estilo. Para obtener una referencia sencilla, agregue esta guía en línea al menú Favoritos del explorador.

  • Escribir contenido para desarrolladores: Teams contenido específico está dirigido a una audiencia de desarrolladores con una comprensión fundamental de los conceptos y procesos de programación. Es importante que proporcione información clara y técnicamente precisa de una manera atractiva mientras mantiene el tono y el estilo de Microsoft.

  • Escribir instrucciones paso a paso: Las experiencias aplicadas e interactivas son una excelente manera para que los desarrolladores aprendan sobre los productos y tecnologías de Microsoft. Presentar procedimientos complejos o simples en un formato progresivo es natural y fácil de usar.

Referencia de MarkDown

Las páginas de Microsoft Docs se escriben en la sintaxis de MarkDown y se analizan a través de un motor Markdig. Para obtener más información sobre etiquetas específicas y convenciones de formato, vea Docs Markdown reference.

Rutas de acceso a archivos

Al usar rutas de acceso relativas y crear vínculos a otros conjuntos de documentos, es importante establecer una ruta de acceso de archivo válida para hipervínculos en la documentación. La compilación se ejecuta GitHub solo si la ruta de acceso del archivo es correcta o válida.

Para obtener más información sobre hipervínculos y rutas de acceso a archivos, vea usar vínculos en la documentación.

Importante

Para hacer referencia a un artículo que forma parte del docset Teams plataforma:
 ✔ use una ruta relativa sin una barra diagonal hacia delante.
 ✔ incluir la extensión de archivo Markdown.
Por ejemplo: directorio primario/directorio/ruta de acceso a article.md :> Crear una aplicación para Microsoft Teams

Para hacer referencia a un artículo de biblioteca de Microsoft Docs que no forma parte del Teams docset de la plataforma:
 ✔ use una ruta relativa que comience por una barra diagonal.
 ✔ No incluya la extensión de archivo.
Ex: /docset/address-to-file-location —> Use la API de Microsoft Graph para trabajar con Microsoft Teams

Para hacer referencia a una página fuera de la biblioteca de Microsoft Docs, como GitHub, use la ruta de https acceso de archivo completa.

Ejemplos de código y fragmentos de código

Los ejemplos de código desempeñan un papel importante para usar api y SDK de forma eficaz. Los ejemplos de código bien presentados pueden comunicar cómo funcionan las cosas más claramente que el texto descriptivo y la información de instrucciones solo. Los ejemplos de código deben ser precisos, concisos, bien documentados y fáciles de usar para el lector. El código fácil de leer debe ser fácil de comprender, probar, depurar, mantener, modificar y extender. Para obtener más información, vea cómo incluir código en los documentos.

Paso siguiente

Consulte también