Compartir a través de

Contribuir a este contenido

  • Artículo

La documentación de Teams forma parte de la biblioteca de documentación técnica de Microsoft Learn . El contenido se organiza en grupos denominados docsets, cada uno de los cuales 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 de dirección URL después de learn.microsoft.com. Por ejemplo, /learn.microsoft.com/microsoftteams/... es el principio de la ruta de acceso del archivo docset de Teams. Los artículos de Teams se escriben en la sintaxis de Markdown y se hospedan en GitHub.

Configurar el área de trabajo

  • Instale dentro de 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 Docs Authoring Pack.
  2. Haga clic en Instalar.
  3. Después de la instalación, el botón Instalar cambia al botón de engranaje Administrar.

Revise la guía del colaborador de Microsoft Docs.

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

Guías de escritura, estilo y contenido de Microsoft

  • Guía de estilo de escritura de Microsoft: La guía de estilo de escritura de Microsoft es un recurso completo para la escritura técnica y refleja el enfoque moderno de Microsoft para la voz y el estilo. Para facilitar la referencia, agregue esta guía en línea al menú Favoritos de su navegador.

  • Escritura de contenido para desarrolladores: el contenido específico de Teams está dirigido a un público desarrollador 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 de que los desarrolladores obtengan información sobre los productos y las 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 Learn se escriben en la sintaxis de MarkDown y se analizan a través de un motor de Markdig. Para obtener más información sobre etiquetas específicas y convenciones de formato, consulte Referencia de Docs Markdown.

Rutas de acceso de archivo

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 los hipervínculos de la documentación. La compilación se realiza correctamente en GitHub solo si la ruta de acceso del archivo es correcta o válida.

Para obtener más información sobre los hipervínculos y las rutas de acceso de archivo, consulte usar vínculos en la documentación.

Importante

Para hacer referencia a un artículo que forma parte del conjunto de documentos de la plataforma Teams:
 ✔ Use una ruta de acceso relativa sin una barra diagonal inicial.
 ✔ Incluya la extensión de archivo Markdown.
Por ejemplo: directorio primario/directorio/ruta de acceso a article.md —>Creación de una aplicación para Microsoft Teams

Para hacer referencia a un artículo de Microsoft Learn que no forma parte del conjunto de documentos de la plataforma Teams:
 ✔ Use una ruta de acceso relativa que comience con una barra diagonal.
 ✔ No incluya la extensión de archivo.
Por ejemplo: /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 Microsoft Learn, como GitHub, use la ruta de acceso completa https del archivo.

Ejemplos de código y fragmentos de código

Los ejemplos de código desempeñan un papel importante para usar las API y los SDK de forma eficaz. Los ejemplos de código bien presentados pueden comunicar cómo funcionan las cosas de forma más clara que el texto descriptivo y la información descriptiva por sí solas. Los ejemplos de código deben ser precisos, concisos, bien documentados y fáciles de usar para el lector. El código que es fácil de leer debe ser fácil de entender, probar, depurar, mantener, modificar y ampliar. Para obtener más información, consulte cómo incluir código en un artículo.

Paso siguiente

Solucionar problemas de la aplicación de Microsoft Teams

Consulte también