1. Redactar un título que resuma el problema específico
El título es la primera cosa que se leerá, así que se debe hacer de forma puntual
- Se debe imaginar que se está conversando con un compañero ocupado y se tiene que resumir la pregunta en una frase: ¿Qué detalles se pueden incluir que ayuden a identificar y resolver el problema? Se deben incluir mensajes de error, key de API o circunstancias inusuales.
- ¡La ortografía, gramática y puntuación son importantes! El título es la primera parte del tema que será leída, debe ser entendible.
- Si se tienen dificultades para resumir el problema, se puede escribir el título al final - En ocasiones, escribir primero el resto de la pregunta puede hacer más fácil describir el problema.
2. Agregar la categoría y las etiquetas necesarias
Agregar una categoría y etiquetas que identifiquen el tema de forma puntual, puede ayudar a que se encuentre más rápido el tema creado.
3. Incluir los metadatos del proyecto
En ocasiones es necesario que se deba revisar el código de un proyecto, si es fuese el caso, es necesario que se incluyan los siguientes metadatos:
- Nombre del sistema
- Las tecnologías base (del arquetipo)
- Versión de JHipster
- Repositorio Git
4. Describir el problema antes de incluir código
En ésta sección del nuevo tema se amplía el resumen del título. Se explica cómo se encontró el problema que se trata de resolver, así como las dificultades que no permiten resolverlo. El primer párrafo del tema es la tercera cosa que se leerán, así que incluye toda la información que te sea posible.
5. Se debe ayudar a reproducir el problema
No todas las preguntas se ven beneficiadas de incluir código, pero si el problema es de código se tendrá que escribir. Pero ¡No escribir el programa entero! Normalmente ésto incluye detalles irrelevantes que se tendrán que ignorar al intentar reproducir el problema. Aquí hay algunas guías:
- Incluir solamente código que permita reproducir el problema.
- NO incluir imágenes de código, datos, mensajes de error, etc. - copiar o escribir el texto en la pregunta. Sólo se deben usar imágenes para diagramas o para mostrar errores de renderizado, cosas que sean imposibles de describir de forma precisa en texto.
Ahora que todo está listo para publicar el tema, se debe tomar un tiempo y léerlo de principio a fin. Una buena práctica es fingir que se está leyendo por primera vez: ¿Tiene sentido? Se debe intentar reproducir el problema en un ambiente nuevo y asegúrarse de que se puede hacer sólo con la información proporcionada en el tema. Agregar cualquier detalle que se haya olvidado y léerla de nuevo. ¡Ahora es un buen momento para asegurarse de que el título aún describe correctamente el problema!
6. Publicar el tema y responde a la retroalimentación
Después de publicar el tema, se debe estar pendiente a que se dé respuesta. Si se omitió información obvia, se debe responder editando el tema incluyéndo ésta. Cuando se reciba una respuesta, se debe hacer una prueba y dar retroalimentación.
7. Ejemplos de títulos
Basándose en lo explicado anteriormente, estos serían algunos ejemplos de títulos incorrectos y correctos:
8. Ejemplo de un mensaje correcto
Éstos serían los datos necesarios y de forma correcta que se deberán proporcionar para que el problema sea atendido de forma correcta:
Nota: Los ** se utilizan debido a que se puede usar sintaxis de markdown para redactar el texto descriptivo del tema.