ベストプラクティス:適切な技術文書の書き方

バージョン 3

    FileMaker® の開発者は、技術文書を書くためにしっかりとしたテクニカル ライティングのスキルが必要になります。技術的バックグラウンドをもたないユーザに対し、複雑な情報を伝える必要があるからです。たとえ執筆する内容が 20 文字のポップアップヘルプであったとしても、この 20 文字をできるだけ明確かつ簡潔にする必要があります。また、自分でソリューションのユーザーズ ガイドを執筆しない場合でも、ユーザーズ ガイドの執筆者に情報を提供する必要があり、執筆者は開発に携わった人物とは限りません。このため、自分の知識を確実に伝える能力が必要となります。また、開発者は多くの場合、クライアントと直接情報を交換する必要があります。この場合の「クライアント」とは、隣の部屋にある広告部門の場合も含まれます。テクニカル ライティングの目標やプロセスについてよく知るほど、クライアントやエンド ユーザによるソリューション全体の体験も向上します。十分な情報を得るほど、エンド ユーザの自信も向上します。結果としてソリューションを信頼し、ソリューションの機能をより良く理解します。また自信をもったユーザからは、役に立つフィードバックが得られ、ソリューションの向上に利用することができます。このようなフィードバックのサイクルを生み出して、維持できれば理想的です。すべては、文書による明確なコミュニケーションから始まります。

    このホワイト ペーパーの内容:

     

     

    - FileMaker の開発で使用される各種文書に関する情報

    - 適切に構成された文書を執筆するための規則

    - 良い執筆例と悪い執筆例

    - 技術文書の発行、配布、維持の方法