TYPO3チュートリアルの最初のセクションでこれまで使用されていたテキスト:
“このドキュメントはチュートリアルです。 チュートリアルは、ステップバイステップのinstructionsspecifically最初から終わりまで、特定のタスクを初心者を歩くために作成されるように設計されています。 効果的な学習を容易にするために、チュートリアルでは、それらがカバーする科目を説明する例を提供します。 さらに、チュートリアルでは、一般的な落とし穴を回避し、将来の参照のために記憶すべき重要な概念を強調する方法に関するガイダンスを提供します。”
以下の文献を見ると、以下の重要なポイントを考慮する必要があります:
- チュートリアルはレッスンであり、学習指向であり、何かを完了するための手順を示し、読者をより知識のあるものにします
- 読者は意味のある何かを達成し、成功を経験し、それが実行可能で楽しいと見つけ、能力を高め、自信を得、そして再びそれをやりたいと考えています。
- 理論的な知識ではなく、実践的な知識に集中してください。 新しい技術やスキルを学び、
ガイドラインを実行することによって学習に集中します:
- ユーザーがやって学ぶことを許可し、
- 単純なものから複雑なものへ
- ユーザーを開始させる
- 初心者が最もよく理解する手順を表示しても大丈夫です。 “ベストプラクティス”は別のものかもしれません。 経験豊富なユーザーがどのようにそれを行うかは別のものかもしれません。
- 目標は、読者を最終的な目的地に到達させるのではなく、読者を開始させることです。
- あなたのチュートリアルが動作することを確認してください!
- : ソフトウェアでは、チュートリアルでは、家庭教師で、そしてもちろん、それらの求められているものを達成するために、独自の能力で。
- ユーザーがすぐに結果を見るようにする
- チュートリアルの各セクション、またはチュートリアル全体の結論は、意味のある成果でなければなりません。
- あなたのチュートリアルは確実に反復可能でなければなりません。
- 抽象的な概念ではなく、具体的なステップに焦点を当てます。 抽象化を導入する誘惑は巨大です:抵抗する!
- 必要最小限の説明を提供
- ユーザーが取る必要がある手順にのみ焦点を当てます
文学¶
- Ubuntu:チュートリアルの書き方
- Daniele Procida:”誰もドキュメントについて教えてくれないこと(May19,2017)-さまざまな種類のマニュアルについての非常に良いblogpost.