Ahora eso JMP Genomics v4.1 se ha puesto en producción, he encontrado un poco de tiempo para ponerme al día con mi lectura. Como estaba leyendo un número reciente de Actas de la Academia Nacional de Ciencias (EE.UU.) , Me sorprendió el hecho de que el límite tradicional de 5 páginas se ha eliminado y que los artículos de 6 o más páginas se han vuelto comunes. Los documentos han crecido a medida que los investigadores intentan empaquetar tanta información como pueden en más y más espacio. Incluso autores de Ciencia Los informes, que tradicionalmente se han limitado a 2500 palabras, evitan las limitaciones de la página al incluir regularmente enlaces a Materiales de apoyo en línea , sitios web que contienen vastas cantidades de datos y descripciones adicionales. Toda esta información tiende a abrumar al lector.
Tal vez solo muestro mi edad de nuevo, pero echo de menos los días en que se limitó a un número establecido de palabras o páginas estrictamente forzadas y no hubo Materiales complementarios en línea . Los autores tenían que asegurarse de que todos los datos y cifras de apoyo necesarios para contar una buena historia se incluyeran en el artículo. Estos requisitos obligaron a los autores a considerar cuidadosamente qué datos eran los más importantes y utilizar el lenguaje más conciso posible. Los buenos papeles eran de gran nitidez y te dijeron lo que necesitabas saber. Fue un placer leerlos.
"Sólo los hechos, señora ..."
En el viejo Rastra Serie de televisión (¡definitivamente estoy mostrando mi edad aquí!), Joe Friday usó estas palabras para eliminar toda la pelusa y llegar a lo esencial. Seguimos la misma filosofía cuando escribimos la documentación para JMP Genomics. Hemos dividido el Guía del usuario de JMP Genomics , por tema, en nueve volúmenes diferentes. Describimos cada proceso en su propio capítulo. Le informamos qué hace el proceso y qué necesita para ejecutarlo. Luego mostramos un ejemplo ilustrativo y le decimos cómo interpretar los resultados.
Cada capítulo está estructurado de la misma manera; Una vez que aprendes cómo funciona para un proceso, sabes cómo funciona para cada proceso.
Un colega mío, que documenta un paquete de software diferente, recientemente me dijo que la documentación de JMP Genomics era bastante simple. En lugar de ser insultada, tomé su comentario como la más alta forma de elogio. La documentación del software no debe contener mucha pelusa. En su lugar, solo debería decirle lo que necesita saber en un formato de fácil acceso y luego debería salirse de su camino.
los Guía del usuario de JMP Genomics está diseñado para hacer precisamente eso.
