0

ソフトウェアアプリケーションのユーザーガイドを作成するのに役立つリソースへのリンクを探しています。私は、ガイドを構成し、適切な文体を与え、全体を通して優れたルックアンドフィールを確保するのに役立つ何かを求めています。

4

2 に答える 2

2

このリンクにはいくつかの長所があります。各ポイントは、明確なスピーチとインラインの正当化で提示されます。

手順を書くときは、能動態を使用し（たとえば、これをクリックします）、ユーザーに直接話しかけます（「ユーザー」ではなく「あなた」と書きます）。

アクションを説明するときは、動詞の「コマンド」形式を使用します。

「メニューからオプションを選択し、[ENTER]を押してください。」

http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml

前述の記事で取り上げたトピックの完全なリストは次のとおりです。

  • フロントページ（表紙）
  • 表紙とタイトルページ
  • 免責事項
  • 序文
  • コンテンツ
  • ガイド本体
  • 手順
  • 書き方
  • チャンキングテキスト
  • ステップに番号を付ける
  • If-Thenアプローチの使用
  • 参考資料
  • バックマター
  • 用語集
  • 索引
  • 基準の確立
  • ドキュメント形式
  • 構造スタイル
  • 技術用語
  • ユーザーへの対応
  • 資料の提示
  • 特別な要件
于 2008-10-20T12:37:53.550 に答える
0

構造とルック アンド フィールについては、DocBook などのフレームワークの使用を検討してください。

DocBook は XML マークアップ スキーマを使用しており、ドキュメントをどのように配置すべきかを考えさせます。HTML や PDF などの一般的な形式に変換するための XSL 変換があり、構成オプションをすべて使用して、希望どおりに表示することができます。しかもオープンソース（無料）です。もちろん、欠点もあります。スキーマは非常に大きく、優れた XML エディターがないと編集は大変な作業になる可能性があります。

例: http://wiki.docbook.org/topic/WhoUsesDocBook

于 2008-10-20T17:08:56.390 に答える