Maintenant que Génomique JMP v4.1 est passé à la production, j'ai trouvé un peu de temps pour rattraper mes lectures. En parcourant un numéro récent du Actes de la National Academy of Sciences (USA) J'ai été frappé par le fait que la limite traditionnelle de 5 pages a été supprimée et que les articles de 6 pages ou plus sont devenus courants. Le nombre d'articles a augmenté, les enquêteurs essayant de rassembler autant d'informations que possible dans un espace toujours plus grand. Même les auteurs de Science Les rapports, qui sont traditionnellement limités à 2500 mots, contournent les limites de la page en incluant régulièrement des liens vers Matériel de support en ligne , des sites Web contenant de grandes quantités de données et de descriptions supplémentaires. Toute cette information a tendance à submerger le lecteur.
Peut-être que je ne fais que montrer mon âge à nouveau, mais je manque le temps où vous étiez limité à un nombre de mots ou de pages strictement appliqué et où Matériel en ligne supplémentaire . Les auteurs devaient s'assurer que tous les faits et chiffres nécessaires pour raconter une bonne histoire étaient inclus dans l'article. Ces exigences ont obligé les auteurs à examiner attentivement les éléments de données les plus importants et à utiliser le langage le plus concis possible. Les bons papiers étaient très tranchants et vous disaient exactement ce que vous deviez savoir. Ils étaient un plaisir de lire.
"Juste les faits, madame ..."
Sur le vieux Drague Série télévisée (je montre très bien mon âge ici!), Joe Friday a utilisé ces mots pour réduire à néant toutes les nuances et arriver à l'essentiel. Nous suivons la même philosophie lorsque nous rédigeons la documentation de JMP Genomics. Nous avons divisé le Guide de l'utilisateur JMP Genomics , par thème, en neuf volumes différents. Nous décrivons chaque processus dans son propre chapitre. Nous vous expliquons ce que le processus fait et ce dont vous avez besoin pour l'exécuter. Nous montrons ensuite un exemple illustratif et vous expliquons comment interpréter les résultats.
Chaque chapitre est structuré de la même manière; Une fois que vous avez appris comment cela fonctionne pour un processus, vous savez comment cela fonctionne pour chaque processus.
Un de mes collègues, qui a documenté un logiciel différent, m'a récemment dit que la documentation de JMP Genomics était plutôt simple. Plutôt que d'être insultée, j'ai pris son commentaire comme la plus haute forme d'éloge. La documentation du logiciel ne doit pas contenir beaucoup de duvet. Au lieu de cela, il devrait simplement vous dire ce que vous devez savoir dans un format facilement accessible et ensuite, cela devrait vous échapper.
le Guide de l'utilisateur JMP Genomics est conçu pour faire exactement cela.
