Esta clase le proporcionará muchas oportunidades para practicar el arte de la escritura de ensayos técnicos. Aquí hay algunas pautas simples que puede usar para evitar problemas comunes.
Nombre el archivo de ensayo de acuerdo con su tema (no su fecha).
Los archivos de ensayo de la plantilla techfolio se nombran con la fecha en que se crearon (es decir, 2015-08-26.md). No haga esto: nombre cada archivo de ensayo para reflejar su tema. Por ejemplo, puedes basar el nombre del archivo en el título de tu ensayo. Si el título de tu ensayo es «Encendiendo el fuego», entonces el nombre de tu archivo podría ser «igniting-the-fire.md».
No incluya espacios en el nombre del archivo: use «igniting-the-fire.md», no «encender la fire.md».
Si el navegador está descargando el archivo en lugar de mostrarlo, probablemente sea porque el nombre del archivo no termina con «.md».
El nombre correcto es importante para que la URL asociada a su ensayo sea fácil de leer y proporcione una indicación de su tema.
Nunca uses «reflect » o» reflections » como parte del nombre de archivo.
Crea un título interesante que atraiga al lector.
No nombre su ensayo con el nombre del módulo (es decir, «Gestión de configuración») o el nombre de la experiencia (es decir, «Reflexiones sobre Javascript»). Los motores de búsqueda a menudo enfatizan el título de las páginas. Quieres leer un ensayo basado en un título así? Con un poco de reflexión, puedes pensar en algo personal (por ejemplo, «La catástrofe de la gestión de la configuración que casi me cuesta mi trabajo») o inteligente («No siempre puedes hacer lo que quieras»).
Nunca uses «reflejar» o «reflejos» como parte de tu título.
Use la ortografía y la gramática adecuadas
No escriba mal las palabras. Usa la gramática apropiada. Si no está seguro, aproveche las herramientas en línea para verificar la ortografía y la gramática antes de la publicación.
Escribe para el mundo, no para el profesor
Aunque muchos de tus ensayos se basarán en tus experiencias haciendo tareas en casa (es decir, experiencias), no escribas tu ensayo como si fuera un correo electrónico privado al profesor explicando la tarea. No cree secciones para responder a cada una de las» preguntas » desde el mensaje. Si haces eso, es casi seguro que crearás un ensayo aburrido que no es interesante de leer.
En su lugar, escríbalo «para el mundo». Supongamos que algún profesional técnico al azar ha estado buscando en Google y surgió tu ensayo. Haga que el ensayo sea autónomo, autoexplicativo y útil para ese profesional aleatorio. Minimice las suposiciones que haga sobre los antecedentes de ingeniería de software de esa persona (¡y mucho menos sus antecedentes en esta clase!) Proporcione enlaces a material de antecedentes si es útil.
No solo debe escribirlo para una variedad de personas, debe escribirlo para una variedad de veces. En otras palabras, trate de escribir su ensayo de manera que si alguien lo lee en un año, siga proporcionando información de valor. Si eres un novato en el tema, escríbelo para proporcionar información y comprensión a otros novatos.
Para que un ensayo sea convincente, por lo general es útil «contar una historia». Crea una narrativa, no solo respondas preguntas.
Formatee el código correctamente
Asegúrese de que el código se muestre correctamente en su publicación. Esto se logra mediante el uso de bloques de código vallados y resaltado de sintaxis. Este es un ejemplo de resaltado de código javascript:
function getTotalCost() { let cost = 0; for (let drink of this.drinks) { cost += drink.price; } return cost;}Piense cuidadosamente antes de incluir fragmentos de código grandes (más allá, digamos, de 50 líneas). Como regla general, mantenga fragmentos de código de una longitud razonable y asegúrese de que todo el código esté directamente relacionado con el tema de su ensayo.
Use encabezados internos para estructurar su ensayo
Los buenos ensayos tienen algún tipo de estructura interna. Ayude al lector a comprender esta estructura proporcionando encabezados internos. No empieces con H1 (es decir, # en Markdown), ya que está reservado para el título de tu publicación. En su lugar, comience con H2 (## en markdown), luego cree subsecciones dentro de esa sección con H3 (### en markdown), etc.
Del mismo modo, utilice listas, cuadros, etc. detallados o enumerados, según corresponda.
Formato y atributo de citas
Ocasionalmente querrá citar a otro escritor en sus ensayos técnicos. Esto está bien, siempre y cuando no presente esas palabras como propias.
Si solo está citando una o dos frases, simplemente puede usar cursiva, comillas y proporcionar el nombre del autor. Por ejemplo:
Como señaló Steve Jobs, » El diseño no es solo lo que parece y se siente. El diseño es como funciona.»
Para comillas más largas, utilice el entorno <blockquote> junto con <pie de página>. Por ejemplo:
Un joven cínico es casi el espectáculo más triste de ver, porque significa que ha pasado de no saber nada a no creer nada.
Incluye imágenes u otros medios
Como dicen, » Una imagen vale más que mil palabras.»Es muy fácil incluir imágenes y videos en sus ensayos. Si el significado de su ensayo se comunicará más claramente con imágenes, tómese el tiempo para encontrarlas e incluirlas. Consulte la sección Formato de la Guía del usuario de TechFolio para obtener instrucciones sobre cómo incluir imágenes y videos.
No seas aburrido, no seas inapropiado
Solo porque el ensayo es de naturaleza técnica, no tiene que ser aburrido. Intenta inyectar tu personalidad en tu escritura. Puedes tener títulos «inteligentes», referencias a la cultura pop, etc.
Por otro lado, no se exceda en la inteligencia. Pregúntate a ti mismo: ¿me avergonzaría si mi madre leyera este ensayo? (Porque podría.) ¿Me avergonzaría si un empleador potencial leyera este ensayo? (Porque podría.)
El objetivo es ser creativo, mostrar algo de personalidad y hacer que el ensayo sea divertido de leer e informativo.
No lo escriba en el último minuto
La calidad de sus ensayos aumentará sustancialmente si los desarrolla de la siguiente manera:
- Escribe el primer borrador.
- Haga otra cosa durante 4 horas.
- Vuelva y haga un pase de edición sobre el primer borrador.
El pase de edición normalmente detectará muchos problemas y te permitirá refinar tus pensamientos de manera significativa, siempre y cuando te hayas alejado del ensayo durante un tiempo suficiente para permitirte verlo con «ojos nuevos». La mejor manera de hacerlo es dormir en él durante la noche, pero si no tienes tanto tiempo, al menos haz algo diferente durante unas horas. Esto le permite a su subconsciente trabajar en el material.
Revisa el contenido y la apariencia de tu publicación
Una vez que la hayas escrito y publicado, recupérala en un navegador y observa cómo se ve.
Un párrafo no es suficiente
Escribir un ensayo de dos o tres frases con la esperanza de obtener algún crédito parcial no es una buena estrategia. Por un lado, un ensayo de este tipo refleja más mal en su persona profesional que ningún ensayo en absoluto. Por otra parte, tendemos a otorgar cero puntos por ensayos que reflejan muy poco esfuerzo.
Haga uso del Centro de Escritura UH Manoa
El Centro de Escritura UHM proporciona consultores que están capacitados para ayudar en todas las etapas del proceso de escritura; ya sea que recién esté comenzando, revisando un borrador o en algún momento intermedio.
Puede programar hasta dos citas por semana, así como tres citas sin cita previa por semana.