Get best of the week

Cómo hacer que su artículo o documentación comprenda de manera rápida y precisa

No solo el contenido, sino también la estructura del texto deben ser significativos.

Entonces, si estamos hablando de un texto técnico o científico, por ejemplo, un artículo o documentación, entonces el formulario debería ayudar a comprender el contenido de manera rápida y fácil. Para mí, en el caso del artículo, esto significa que la estructura debería ser algo como esto:

  • Titular
  • La esencia del artículo En
    base a estas pocas oraciones, junto con el titular, el lector debe comprender si está interesado en leer este artículo más a fondo.
  • Resumen
    Aquí, en la forma más concisa, tesis, pero con la precisión y exhaustividad necesarias, la esencia de este artículo debe reflejarse: de varias oraciones a varias páginas. Alguien profundo en el tema puede ser suficiente para entender todo el artículo. Pero, en cualquier caso, es útil para el lector presentar de la forma más general de qué trata este artículo y qué conclusiones recibirá al final.
  • La lógica del artículo
    Si el artículo es largo, contiene muchas secciones y una lógica compleja, este capítulo también puede ser útil. Esto es esencialmente una tabla de contenido extendida. Aquí, brevemente, en una o dos páginas, se establece la lógica del razonamiento, secamente, sin detalles. Nuevamente, esto será suficiente para que alguien entienda todo. Si es difícil, el lector puede omitir esto (como una tabla de contenido) y seguir leyendo.
  • Presentación simplificada
    Si el artículo es bastante complicado, sería conveniente para muchos entender primero conceptualmente lo que el autor quiere decir. Por lo tanto, es bueno decir primero todo como si le estuvieras diciendo a los estudiantes, faltando evidencia compleja y tal vez no en un lenguaje tan formal y estricto. Para muchos, este nivel de presentación puede ser suficiente, y se detendrán aquí.
  • Presentación estricta
    Aquí hay una presentación estrictamente profesional.

Por supuesto, la estructura no tiene que ser solo eso. Por ejemplo, dependiendo de la complejidad y la longitud del texto, algunas secciones pueden ser redundantes o, por el contrario, pueden agregarse, pero la estructura debe ser apropiada para el propósito. En este caso, el enfoque establecido le permite al lector comprender el contenido de un artículo complejo lo más rápido posible y con el grado de profundidad necesario. Utilicé este enfoque al escribir el artículo Ecuaciones diferenciales no lineales, la discreción del espacio-tiempo y el producto épsilon . Verá todos los artículos excepto el último.

Tengo que leer mucha documentación técnica. En mi opinión, la organización generalmente aceptada del texto es inconveniente. No tengo tiempo (y deseo) para disfrutar del desarrollo constante de la trama y la belleza de la sílaba, esto no es "Guerra y paz", solo necesito información y cuanto más rápido, mejor. Por lo tanto, en el caso de un tema nuevo y complejo, primero tengo que escanear el texto varias veces en busca de significados, conclusiones y lógica, y solo entonces puedo percibirlo adecuadamente. Es decir, de hecho, sigo el enfoque descrito, pero de una manera muy inconveniente y que requiere mucho tiempo, y sería mucho más conveniente para mí si la información se organizara inmediatamente de acuerdo con esto.

More articles:


All Articles