今 JMPゲノミクス v4.1 生産に行った、私は私の読書に追いつくために少し時間を見つけました。私は最近の問題を熟読していたのでアメリカ科学アカデミー論文集私は、5ページという従来の制限が廃止され、6ページ以上の記事が一般的になっているという事実に驚きました。研究者ができる限り多くの情報をより多くのスペースに詰め込もうとするにつれて、論文は増えてきました。の作者でも科学従来2500語に制限されていたレポートは、定期的にへのリンクを含めることでページ制限を回避します。オンライン資料のサポート膨大な量の追加データや説明を含むWebサイト。この情報はすべて読者を圧倒する傾向があります。
たぶん私は再び私の年齢を見せているのですが、あなたが厳密に設定された数の単語やページに制限されていた時代を見逃しています。補足オンライン資料 。著者は、良い話をするのに必要な裏付け事実と数字のすべてが記事に含まれるようにしなければなりませんでした。これらの要件により、著者はどのデータが最も重要であるかを慎重に検討し、可能な限り最も簡潔な言語を使用することを余儀なくされました。良い論文は非常に鋭くて、あなたが知る必要があるものだけをあなたに話しました。彼らは読むのが楽しみでした。
「事実だけ、奥さん…」
昔のドラグネットテレビシリーズ(私はここで自分の年齢を最も確実に示しています!)、Joe Fridayはこれらの単語を使用して毛羽立ちを全部断ち切り、必需品に降りました。JMP Genomicsのドキュメントを書くときも、同じ考え方に従います。私達は分けました JMP Genomicsユーザーガイドテーマ別に、9つの異なるボリュームに。各プロセスについて、それぞれの章で説明します。そのプロセスが何をしているのか、そしてそれを実行するために何が必要なのかをお伝えします。それから、実例を示して、結果をどう解釈するかをあなたに話します。
各章は同じように構成されています。それが1つのプロセスに対してどのように機能するかを学んだら、あなたはそれがすべてのプロセスに対してどのように機能するかを知っています。
別のソフトウェアパッケージを文書化している私の同僚は、最近私にJMP Genomicsの文書化はかなり単純であると言った。侮辱されるのではなく、私は彼女のコメントを最高の賞賛の形として取りました。ソフトウェアのドキュメントにはたくさんの毛羽立ちがあってはいけません。代わりに、簡単にアクセスできる形式で知っておくべきことを説明し、それから邪魔にならないようにします。
の JMP Genomicsユーザーガイドまさにそれをするように設計されています。