Nun das JMP Genomics v4.1 ist in Produktion gegangen, ich habe etwas Zeit gefunden, um meine Lektüre nachzuholen. Da habe ich eine aktuelle Ausgabe des gelesen Verfahren der National Academy of Sciences (USA) Ich war beeindruckt von der Tatsache, dass das traditionelle Limit von 5 Seiten verworfen wurde und Artikel ab 6 Seiten allgemein üblich sind. Papiere sind gewachsen, da die Ermittler versuchen, so viele Informationen wie möglich in immer mehr Weltraum zu packen. Sogar Autoren von Wissenschaft Berichte, die traditionell auf 2500 Wörter begrenzt waren, umgehen die Seitenbeschränkungen, indem regelmäßig Links eingefügt werden Unterstützende Online-Materialien Websites, die eine Vielzahl zusätzlicher Daten und Beschreibungen enthalten. Alle diese Informationen überwältigen den Leser.
Vielleicht zeige ich nur wieder mein Alter, aber ich vermisse die Tage, an denen Sie auf eine streng bestimmte Anzahl von Wörtern oder Seiten beschränkt waren und es keine gab Ergänzende Online-Materialien . Die Autoren mussten sicherstellen, dass alle wichtigen Fakten und Zahlen, die für eine gute Geschichte benötigt werden, in den Artikel aufgenommen wurden. Diese Anforderungen zwangen die Autoren, sorgfältig zu überlegen, welche Daten am wichtigsten sind, und die möglichst kurze Sprache zu verwenden. Gute Papiere waren gestochen scharf und sagten Ihnen genau, was Sie wissen mussten. Es war eine Freude zu lesen.
"Nur die Fakten, Ma'am ..."
Auf dem alten Entmagnetisieren TV-Serie (ich zeige auf jeden Fall mein Alter hier!), Verwendete Joe Friday diese Worte, um all den Fussel zu durchschneiden und sich auf das Wesentliche zu konzentrieren. Wir verfolgen dieselbe Philosophie, wenn wir die Dokumentation für JMP Genomics schreiben. Wir haben das geteilt JMP Genomics Benutzerhandbuch thematisch in neun verschiedene Bände. Wir beschreiben jeden Prozess in einem eigenen Kapitel. Wir sagen Ihnen, was der Prozess macht und was Sie benötigen, um ihn auszuführen. Wir zeigen dann ein illustratives Beispiel und erklären Ihnen, wie Sie die Ergebnisse interpretieren.
Jedes Kapitel ist auf dieselbe Weise aufgebaut. Sobald Sie wissen, wie es für einen Prozess funktioniert, wissen Sie, wie es für jeden Prozess funktioniert.
Ein Kollege von mir, der ein anderes Softwarepaket dokumentiert, sagte mir kürzlich, dass die Dokumentation zu JMP Genomics ziemlich einfach sei. Anstatt beleidigt zu sein, nahm ich ihren Kommentar als höchste Form des Lobes an. Die Softwaredokumentation sollte nicht viel Flusen enthalten. Stattdessen sollten Sie nur wissen, was Sie in einem leicht zugänglichen Format wissen müssen, und dann sollte es Ihnen aus dem Weg gehen.
Das JMP Genomics Benutzerhandbuch soll genau das tun.
