Búsqueda de sitios web

Lista de verificación editorial

Este es un resumen de las reglas que se deben aplicar al escribir artículos nuevos o actualizar artículos existentes. Consulte otros artículos en la Guía del colaborador para obtener explicaciones detalladas y ejemplos de estas reglas.

Metadatos

  • ms.date: debe tener el formato MM/DD/AAAA

    • Cambiar la fecha cuando haya una actualización importante o factual

      • Reorganizando el artículo
      • Corrección de errores fácticos
      • Agregar nueva información

    • No cambies la fecha si la actualización es insignificante.

      • Corrección de errores tipográficos y de formato

  • title: cadena única de 43 a 59 caracteres (espacios incluidos)

    • No incluya el identificador del sitio (se genera automáticamente)
    • Utilice mayúsculas y minúsculas: escriba en mayúscula sólo la primera palabra y los nombres propios.
  • descripción: 115-145 caracteres incluidos espacios: este resumen se muestra en el resultado de la búsqueda

Formato

  • Elementos de sintaxis de acento grave que aparecen, en línea, dentro de un párrafo

    • Nombres de cmdlets Verb-Noun
    • Variable $contador
    • Ejemplos sintácticos Verbo-Sustantivo-Parámetro
    • Rutas de archivo C:\Program Files\PowerShell, /usr/bin/pwsh
    • URL en las que no se puede hacer clic en el documento
    • Valores de propiedad o parámetro

  • Utilice negrita para nombres de propiedades, nombres de parámetros, nombres de clases, nombres de módulos, nombres de entidades, nombres de objetos o tipos.

    • La negrita se utiliza para marcado semántico, no para énfasis.
    • Negrita: utilice asteriscos **

  • Cursiva: utilice guión bajo _

    • Sólo se utiliza para énfasis, no para marcado semántico.
  • Saltos de línea en 100 columnas (o en 80 para about_Topics)
  • Sin pestañas fijas: use solo espacios
  • Sin espacios finales en las líneas
  • Las palabras clave y los operadores de PowerShell deben estar todos en minúsculas.
  • Utilice mayúsculas y minúsculas adecuadas (Pascal) para los nombres y parámetros de los cmdlets

Encabezados

  • H1 es el primero: solo un H1 por artículo
  • Utilice únicamente encabezados ATX
  • Utilice mayúsculas y minúsculas para todos los encabezados
  • No te saltes niveles: no hay H3 sin H2
  • Profundidad máxima de H3 o H4
  • Línea en blanco antes y después.
  • PlatyPS aplica encabezados específicos en su esquema: no agregue ni elimine encabezados

Bloques de código

  • Línea en blanco antes y después.
  • Utilice barreras de código etiquetadas: powershell, Salida u otro ID de idioma apropiado.
  • Valla sin etiquetar: bloques de sintaxis u otros shells
  • Coloque la salida en un bloque de código separado, excepto en los ejemplos básicos en los que no desea que el lector use el botón Copiar.
  • Ver lista de idiomas soportados

Liza

  • Sangrado correctamente
  • Línea en blanco antes del primer elemento y después del último elemento
  • Viñeta: utilice un guión (-) y no un asterisco (*) para reducir la confusión con el énfasis.
  • Para listas numeradas, todos los números son "1".

Terminología

  • PowerShell frente a Windows PowerShell
  • Ver terminología del producto

Ejemplos de referencia de cmdlets

  • Debe tener al menos un ejemplo en la referencia del cmdlet.

  • Los ejemplos deben ser suficiente código para demostrar el uso.

  • Sintaxis de PowerShell

    • Utilice nombres completos de cmdlets y parámetros, sin alias
    • Utilice salpicaduras para los parámetros cuando la línea de comando sea demasiado larga
    • Evite el uso de comillas invertidas de continuación de línea; utilícelas solo cuando sea necesario

  • Eliminar o simplificar el mensaje de PowerShell (PS>) excepto cuando sea necesario para el ejemplo.

  • El ejemplo de referencia de cmdlet debe seguir el siguiente esquema de PlatyPS

    ### Example 1 - Descriptive title

Zero or more short descriptive paragraphs explaining the context of the example followed by one or
more code blocks. Recommend at least one and no more than two.

```powershell
... one or more PowerShell code statements ...
```

```Output
Example output of the code above.
```

Zero or more optional follow up paragraphs that explain the details of the code and output.

  • No coloque párrafos entre los bloques de código. Todo el contenido descriptivo debe ir antes o después de los bloques de código.

Enlace a otros documentos

  • Al vincular fuera del conjunto de documentos o entre referencia de cmdlet y concepto

    • Utilice URL relativas al sitio al vincular a Microsoft Learn (elimine https://learn.microsoft.com/en-us)
    • no incluya configuraciones regionales en las URL de las propiedades de Microsoft (por ejemplo, elimine /en-us de la URL)
    • Todas las URL de sitios web externos deben utilizar HTTPS a menos que no sea válido para el sitio de destino.

  • Al vincular dentro del conjunto de documentos

    • Utilice la ruta de archivo relativa (por ejemplo, ../carpeta/archivo.md)
  • Todas las rutas utilizan caracteres de barra diagonal (/)
  • Los enlaces de imágenes deben tener texto alternativo único.

Artículos relacionados