First make sure that the article title describes the issue. Examples:
- Good: "Cancelling a File Copy dialog crashes the File Manager"
- Bad: "Software crashes"
- BAD: “Lenovo R60”
- Good: “HDD is not detected in Lenovo R60, HBA Intel(R) 82801GMB/GHM”
Problem
Describe the problem as the user would experience it. For example: "Level 7 printer is flashing red and wont print".
If the problem is version specific, mention it here.
Cause
Describe the cause of the problem. The cause can be for example a common mistake that users do or a known defect.
Resolution
Provide the steps that the user should take to solve the problem. For example: "The level 7 printer will flash red when it is out of paper. Add paper to tray 1".
You can use a panel to highlight important steps.
- Use numbered lists to provide step-by-step help.
- Copy and paste or drag and drop images to add them to this page.
If a resolution can be found directly from some already existing KB article, add the URL here.
If there is a known version where the problem is fixed, it should be mentioned here.