Guía de estilo para la redacción de contribuciones
Autor: Carlos Manuel Chee Vázquez
La plantilla del documento para contribuir está en formato de Documento de Google. Haz una copia de ella para que puedas renombrarla y editarla.
Para poder subir tu contribución lo más rápido posible, te pedimos sigas estas sugerencias:
- Respeta el formato de la plantilla. Continua usando los estilos de Título, Subtítlo, Encabezado 1, Encabezado 2, y demás para que tu información tenga la estructura que necesitamos para agregarla automáticamente a la documentación.
- Describe los pasos del procedimiento. Piensa en el procedimiento como una acción de pasos en secuencia que debe ser realizada por muchas otras personas también, más allá de imaginarlo como una actividad que tú haces. Esto te ayudará a definir el orden y los pasos, y describirlos de una manera que pueda ser replicada por cualquiera.
- Usa capturas de pantalla específicas. Si necesitas agregar capturas de pantalla, recorta la captura enfocándote en el área específica a la que se refiere el paso, por ejemplo, un botón o sección de la página, en lugar de usar la foto de toda la pantalla con alguna anotación. Esto ayudará a enfocar la atención en el elemento específico.
- Usa títulos y subtítulos. Si tu procedimientoes largo, divídelo en secciones que puedes separar con títulos y subtítulos para que sea más fácil de seguir. Es más accesible un tema largo si se divide en muchos temas pequeños.