Absolutely!
What we need:
Before asking for help, please try to provide as much relevant information as possible. The better the information, the more likely it is that someone can (and wants to) help.
This checklist is intentionally broad, but it is not complete. Depending on the problem, additional information may be required. If in doubt, provide more information rather than less.
Please make sure that a reader with no prior knowledge of your project can understand the situation without having to guess important details or search for missing information.
1. What?
- What exactly is the problem?
- What is the expected behavior?
- What happens instead?
- Is the problem permanent, intermittent, or random?
- When did the problem start?
2. Where?
-
Where is the system used?
-
Indoor, outdoor, vehicle, industrial environment, underwater, etc.
-
Relevant environmental conditions:
- Temperature
- Humidity
- Dust
- Vibration
- Pressure
- Saltwater
- Chemicals
- Weather exposure
3. How?
- How is the system built?
- How are the components connected?
- How is it powered?
- How is it operated?
- What has already been tested?
- What were the results?
4. Hardware / Materials
5. Dimensions / Ratings
Provide numbers whenever possible:
- Voltage
- Current
- Power
- Pressure
- Temperature
- Speed
- Torque
- Weight
- Dimensions
- Distance
- Load
Always include units.
6. Documentation
If available, provide:
- Schematics
- Wiring diagrams
- Circuit diagrams
- Datasheets
- Relevant code snippets
- Error messages (complete and unedited)
- Log files
7. Visual Information
A picture is often worth more than a page of text.
Useful examples:
- Photos
- Screenshots
- Sketches
- Drawings
- CAD models
- Block diagrams
8. System Context
Help others understand the overall objective:
-
What is the device or system supposed to do?
-
What is the purpose of the project?
-
What requirements must be met?
-
What constraints exist?
- Cost
- Size
- Weight
- Power consumption
- Reliability
- Maintenance
9. Consequences of Failure
This is often one of the most important pieces of information.
What happens if the system fails?
Possible consequences include:
- Minor inconvenience
- Loss of functionality
- Data loss
- Equipment damage
- Damage to other systems
- Production downtime
- Financial loss
- Environmental damage
- Safety hazards
- Personal injury
- Risk to human life
Also indicate:
- How quickly must the failure be detected?
- How quickly must corrective action be taken?
- Is the failure recoverable?
- Is maintenance or repair possible after failure?
10. Research Already Performed
- What information have you already found?
- What solutions have you already tried?
- What worked?
- What did not work?
- Why were the attempted solutions rejected?
11. Additional Relevant Information
This checklist cannot cover every possible situation.
Please include any additional information that you believe may be relevant, even if it does not seem important at first glance.
What may appear insignificant to you could be the key detail for someone with experience in that specific field.
12. Community Knowledge
No checklist can anticipate every problem.
If you are responding to a request for help and believe important information is missing, please ask for it.
Likewise, if your expertise suggests that this checklist can be improved, refined, or expanded for a particular field or application, please do so.
The goal is not to complete a checklist. The goal is to provide enough information for others to understand the problem and help effectively.
Remember:
People can only work with the information provided. Missing information leads to assumptions, unnecessary questions, and often the wrong answers.
The clearer the problem description, the better the chances of receiving useful help.