User Documentation A continuación se establecen los requisitos básicos para dar formato a su artículo de documentación.
Referencias
Páginas de resumen
Un artículo que presenta una sección con introducciones y enlaces a subsecciones.
Párrafo de introducción
Enlaces a secciones con breves descripciones
- Utilice una sangría para dar formato a cada enlace
- El enlace es idéntico a como aparece en el menú.
- El enlace va seguido de una raya (espacio-raya-espacio) y luego una introducción de una o dos frases a la subsección que describa cómo amplía el tema general.
El párrafo de resumen relaciona la sección de nuevo con la categoría, es decir, relaciona un tema de gestión de contenidos de nuevo con Gestión de contenidos.
Enlazar a una subsección
Enlaces de subsección
Encabezados
Mayúsculas y minúsculas en títulos (Title Case)
Poner en mayúscula
- La primera y la última palabra (siempre)
- Sustantivos, verbos, adjetivos, adverbios
- Palabras de 4 o más letras (regla general habitual)
Poner en minúscula
- Preposiciones cortas: en, por, a, de, para, hasta
- Artículos: un, una, el, la
- Conjunciones cortas: y, pero, o, ni, así que
Ejemplo
A Guide to the Rules of Title Case and How to Use Them
Ampersand &
Úselo en los menús únicamente como sustituto de la palabra "y", pero nunca en los títulos de los artículos.
Elemento del menú
6 Paginación & Leer más
Título del artículo
6 Paginación y Leer más
Numeración
Cuando el contenido sigue una estructura de esquema o índice numerado, no añada puntos al final de un número.
Sí
6 Paginación y Leer más
No
6. Paginación y Leer más
Etiquetas
- Tutorial
- Gestión de contenidos
- Creación de sitios
- Mantenimiento del sitio
Capturas de pantalla
Consulte Consejos para mejores capturas de pantalla para una guía detallada.
Notas: ancho de 1500–2500px; fondo del navegador claro (no oscuro); recorte adecuadamente para orientar al usuario y mostrar los detalles relevantes; zoom del navegador para mejorar el texto; formato de archivo PNG.
Leyendas
Cuando se configura con una leyenda (clic derecho y marcar la casilla de leyenda), la imagen se envuelve en un bloque <figure> con el pie de foto adecuado; de lo contrario, la imagen se muestra en una condición estándar en línea.
Colocación
Tamaño
Anchos estándar: 960px para ancho completo, y 320px o 640px para anchos parciales.
Los anchos grandes (mayores a 1000px) se redimensionan automáticamente en el navegador al ancho del artículo. Las imágenes más pequeñas se justifican a la izquierda.
Atribución
Si la captura de pantalla incluye imágenes, ¿deberíamos atribuir la fuente? ¿Y cómo?