Esta plantilla describe los estándares para escribir artículos informados. Utilice los artículos de la base de conocimientos de Apple como ejemplo: https://support.apple.com/en-ca/HT207935
Título
El título del artículo debe reflejar el contenido del artículo para facilitar el reconocimiento y la búsqueda.
Ejemplos: "¿Cómo elimino una canción?", "Bienvenido a Anytune iPhone / iPad"
Pautas
- Evite la creación de artículos duplicados. Busque cuidadosamente antes de crear.
- Comience con "Título 2" para los títulos. El título del artículo es el Título 1 y solo debe haber uno.
- Escriba con mayúscula los nombres de los productos y los nombres de los botones de texto:
Toque el botón Editar. No hagas comandos en negrita. - Use la imagen de la tabla de botones (svg) con un tamaño de 22 píxeles de alto cuando el botón usa un ícono:
Toque Restaurar - Utilice cotizaciones para seleccionar opciones:
3. Elija "Canción afinada" y "Correo electrónico". - Para seguir las jerarquías, utilice:
Vaya a Menú de Anytune> Archivos> Exportar configuración> Exportar a archivo ... - Utilice listas numeradas para los pasos de un procedimiento.
Los pasos terminan en un período. - Los títulos de los procedimientos son H @ y terminan en dos puntos. Ejemplo: "Título del procedimiento:"
- Cuando los pasos sean diferentes para las versiones del producto, cree varias secciones con el título de descripción 3 títulos
- Utilice viñetas para las listas.
- Mantener el contexto del cliente
- Recuerda a la audiencia
- No haga referencia a un cliente
- Abstenerse de abreviaturas y acrónimos
- Asegúrese de que todos los enlaces funcionen
Etiquetas
Incluya etiquetas apropiadas con los artículos. Las etiquetas influyen en la relevancia de la búsqueda de artículos y en los resultados del bot de respuesta. También se pueden utilizar para crear listas de artículos.
Use una sola palabra cuando sea posible y no use variaciones de la misma palabra. Utilice etiquetas con moderación.
Ejemplos: macOS, importación, bluetooth, ReFrame
Modelo
Declaración resumida de lo que le dirá este artículo.
Utilice el encabezado 3 para el proceso y para distinguir plataformas
- Pasos del proceso
- Toque en el
Boton de ayuda
- Elija "Correo electrónico"
- Toque Editar
En Mac, el proceso para esto es
Nota: proporcione notas en <p class = "anytune-note"> nota </p>
Advertencia: proporcione notas en <p class = "anytune-warning"> nota </p>
Enfatice resaltando con <p class = "anytune-highlight"> nota </p>
Más información (H3)
Dile al usuario dónde se encuentra más información mediante enlaces .
Cómo corregir problemas
Cuando el artículo describe cómo resolver un problema, incluya estas secciones
- Problema: Describe el problema y trata de usar las palabras del cliente.
- Entorno: describa la instalación y la configuración a las que se aplica esta corrección (opcional)
- Resolución: estos son los pasos para resolver
- Causa: qué escenario causó o pudo haber causado el problema
- Etiquetas: incluya palabras que se relacionen con el artículo en cuestión para ayudar
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.