When using industry-specific terms or abbreviations, provide a description. Use upbeat language that supports and encourages users looking for help. Make certain users can find information. Provide a detailed index that reflects the way your customers think. User documentation tips . . . to create information that users understand Present information clearly, incorporating visual examples.
Pictures are often more effective than words - especially when explaining abstract concepts.
Use simple language, avoiding colloquialisms or slang. Address the needs of your users by writing task-based topics and procedures, rather than simply documenting how the product works. Use consistent formatting, styles, and typography. Create tasks and examples that are meaningful to the learners. Create learner materials that can be used as a simple reference on the job.