Cantidad de detalles en un documento profesional

Diría que la claridad debe ser el rey en el sentido de que si desea que el documento se lea más allá de la introducción y se desarrolle a partir de él, lo mejor que puede hacer es presentar la idea principal (o ideas) en el entorno más simple y no trivial donde puede deletrearlo todo con todos los detalles debidos sin convertirlo en una pesadilla técnica.

La trampa estándar en la que cae la gente es tratar de presentar el resultado más fuerte y más general que puedan probar. Nueve de cada diez veces resulta que la dirección de la generalización que eligieron no es la que les interesa a las otras personas más tarde y uno tiene que pasar horas o semanas deshaciendo toda la acumulación sofisticada y reduciendo la prueba a su esencia. donde todo lo demás tiene que ser reconstruido de una manera completamente diferente. Entonces, presentar claramente este núcleo desde el principio sería muy beneficioso, en mi humilde opinión. La palabra "claramente" significa "con todos los detalles relevantes y con un número mínimo de referencias externas" + "de la manera más fácil de comprender posible".

Por tradición, un artículo matemático tiene que contener algún resultado nuevo (preferiblemente una solución de algún problema sin resolver razonablemente antiguo) solo para demostrar que las técnicas que promueves valen algo pero, para la mayoría de los artículos, los resultados en sí son de mucho menos interés que los nuevos giros en las demostraciones. Su "teorema central", probablemente, se olvidará o se mejorará mucho en unos pocos años, pero algún pequeño lema puede adquirir fácilmente una vida independiente y cuanto más simple sea ese lema, más oportunidades tendrá (siempre que, por supuesto, sea por encima de un cierto umbral en términos de novedad e ingenio).

El "truco organizacional" principal es tratar de escribir sobre una cosa a la vez. Hay casos en los que puedes y debes montar "fuegos artificiales explosivos de ideas" pero son raros, pocas personas son capaces de eso y aún menos saben cómo hacerlo de una manera que ilumine las cosas en lugar de cegar y confundir al lector. Entonces, el (in) famoso principio KISS es una buena regla general en la mayoría de las ocasiones. Ese y el enfoque clásico de "divide y vencerás" pueden hacer milagros en lo que se refiere a la claridad de la comunicación. Una vez escuché que un mal profesor siempre está pensando si olvidó incluir algo en el curso y uno bueno está preocupado si puso algo innecesario.

Las pruebas deben estar completas y detalladas. A menudo se dice que dos trivialidades omitidas seguidas pueden crear una barrera impenetrable para el lector. Pruebe un resultado más débil o menos general de lo que pueda, si siente que el argumento se enreda demasiado de lo contrario, pero pruébelo en su totalidad y dedique algún tiempo a pensar cómo presentarlo de la manera más lógica y fácil de entender. Una hora ahorrada por el escritor a menudo resulta en unos pocos días desperdiciados por el lector (que también debe multiplicarse por el número de lectores).

No existe una regla estricta, porque la buena comunicación es tanto un arte como una ciencia. Sin embargo, en mi opinión, la mayoría de los artículos de matemáticas están escritos con muy pocos detalles. Es posible dar demasiados detalles, pero en la práctica casi nunca lo veo. Por lo tanto, los animo a usted y a todos los demás a errar por el lado de más detalles, en lugar de menos.

Si le preocupan los detalles que distraen la atención del objetivo principal del trabajo, la mejor manera de mitigar esto es organizar el papel de manera muy clara, con mucha señalización. Divida los argumentos largos en lemas siempre que tenga sentido hacerlo. Esto permite al lector omitir los detalles que no desea leer.

Los apéndices, las notas al pie/notas al final y los materiales complementarios son sus amigos

Estoy en su campo aquí, en la medida en que prefiero escribir de una manera que "fluya" bien, apegado a las líneas principales de pensamiento y evitando divergir en temas secundarios que distraigan al lector. Las tres primeras reglas de la buena redacción son: claridad , claridad , claridad.. En consecuencia, casi todos los artículos de matemáticas que escribo desplazan cantidades sustanciales de material fuera del cuerpo principal del artículo. Me gusta poner pruebas de teoremas en apéndices (a menos que el método de prueba sea importante para comprender el material del cuerpo), aspectos secundarios del material y advertencias menores en notas al pie, y codificación y otros materiales en materiales complementarios. Esto me permite escribir de una manera en la que el cuerpo principal del artículo fluye naturalmente y le brinda al lector una discusión clara e intuitiva del problema de investigación en cuestión.

• No tenga miedo de brindar ayuda/discusión heurística: en el extremo extremo de la brevedad, algunos trabajos y notas de matemáticas son esencialmente prueba de teorema-prueba de teorema, etc., y puede ser difícil para el lector ver cómo los autores descubierto para utilizar los métodos en uso. En mi opinión, es útil dividir esto dando al menos una discusión heurística para ayudar al lector a comprender por qué se eligió un teorema o método de prueba en particular, y qué lo motivó. Está bien hablar heurísticamente aquí, y una pequeña cantidad de detalles adicionales sobre motivaciones, métodos, etc., puede marcar una gran diferencia en la comprensión del tema.

• A menudo, puede colocar las pruebas en un apéndice: en algunos casos, una prueba matemática puede resaltar aspectos importantes del tema en discusión (y en este caso, es posible que desee incluirla en el cuerpo del artículo), pero a menudo la prueba está allí solo para garantizar que el teorema está probado. Mover las pruebas a un apéndice le permite afirmar sus teoremas y luego discutir su significado, y los lectores interesados ​​pueden buscar la prueba si es necesario.

• Las notas al pie/notas al final se pueden usar para evitar la interrupción de los argumentos: a menudo, desea tener una línea principal de discusión en la que hable en términos generales, de una manera que no exija la atención del lector. En algunos casos, puede haber algunas advertencias técnicas menores u otros puntos menores que desee hacer, pero tiene miedo de que interrumpan el flujo de la discusión. En tales casos, las notas a pie de página brindan una forma útil de abordar una advertencia menor sin interrumpir el flujo de argumentos para el lector.

• Los materiales complementarios son buenos para, bueno, materiales complementarios: algunos trabajos de matemáticas se complementan con simulaciones por computadora, codificación reproducible, etc., y en tales casos, estos generalmente deberían estar disponibles en materiales complementarios. Rara vez es útil incluir grandes cantidades de código de computadora en un documento (a menos que parte de su tarea sea explicar cómo implementar algo en el software computacional), por lo que generalmente es mejor sacarlo del cuerpo.

Siendo realistas, ninguno de tus lectores leerá más allá de la introducción. Escribe una introducción larga con tus principales líneas de pensamiento. Para un artículo largo, las personas con frecuencia ahora incluso escriben una introducción a la introducción, de modo que la primera o dos páginas dicen de qué trata el artículo, luego los siguientes cuatro o cinco artículos presentan las ideas principales del artículo y luego el resto. contiene todos los detalles.

Los lemas particularmente técnicos cuyas demostraciones son largas pero no esclarecedoras se pueden probar en las secciones al final del artículo. En particular, no es necesario que proporcione siempre la prueba de una declaración antes de usarla, aunque si difiere una prueba, debe tener cuidado de dejar en claro que no tiene una prueba circular.

En cuanto al nivel de detalle a incluir, mi sugerencia es elegir a una persona específica como su lector previsto para el documento e incluir todos los detalles que serán necesarios para ellos. No elija al experto líder en su campo oa uno de sus colaboradores cercanos. Con frecuencia, es mejor elegir a un estudiante de posgrado, y está bien si no es más específico que el hipotético estudiante de doctorado de X que recién comienza a investigar.