I personally think "steps you took before the problem occured" help out a lot in understanding the issue and giving good advice. It also helps if the title is a short summary of the problem (yeah I know, Id add it anyway), whether or not the person asked elsewhere for advice (e.g. xpost with stack exchangen) to avoid redudancy and what steps they already did in an attempt to solve the problem.
Edit: also maybe a few "donts", e.g. dont add nonsense votes or make the thread self moderated for no reason.
Topic: [READ BEFORE POSTING] Tech Support Help Request Format (Read 60180 times)
This is a continuation of https://bitcointalksearch.org/topic/standardizing-tech-support-help-requests-1282666 to actually make the format standard and stickied.
The Format
When creating a new help request in the Tech Support section, please use the following format. It will make it easier for others to help you as this format contains the information that is needed to provide the proper help.
Explanation of each field
Bitcoin Client Software and Version Number: The name of the software you are using and the Version number. We will always need to know this information.
Operating System: The name, version number, and bitness of your operating system. This is not always necessary. It is only needed for issues with your Bitcoin Client.
System Hardware Specs: The CPU, RAM, and Hard drive space of the computer that you are using. This is not always necessary. It is only needed for issues with your Bitcoin Client.
Description of Problem: The description of the problem you are having. This is always necessary. We need to know what is wrong.
Any Related Addresses: Any addresses related to the problem you are having. This is not always necessary. We only need to know this if you are having issues with transactions.
Any Related Transaction IDs: Any transaction IDs related to the problem that you are having. This is not always necessary. We only need to know this if you are having issues with transactions.
Screenshot of the problem: A screenshot of the problem that you are having uploaded to an image hosting service such as https://imgur.com. This is not always necessary. It is only needed for issues with your Bitcoin Client.
Log Files from the Bitcoin Client: A link to the log files created by your client uploaded to paste sites such as https://pastebin.com. This is not always necessary. It is only needed for issues with your Bitcoin Client. Not all software have options for exporting log files. If the log file is too large, just paste as much as you can from the bottom of the file.
Examples
The following are two example reports. The first example is one for a software client issue. The second example is for a transaction issue.
If you have any issues with getting any of these fields, still make your help request post and state that you have issues with getting the information for the fields that you have issues with. Users here will guide you on how to get it.
This format can change and evolve as it is used and other users comment on it.
The Format
When creating a new help request in the Tech Support section, please use the following format. It will make it easier for others to help you as this format contains the information that is needed to provide the proper help.
Quote from: Standard Format
Bitcoin Client Software and Version Number:
Operating System:
System Hardware Specs:
Description of Problem:
Any Related Addresses:
Any Related Transaction IDs:
Screenshot of the problem:
Log Files from the Bitcoin Client:
Operating System:
System Hardware Specs:
Description of Problem:
Any Related Addresses:
Any Related Transaction IDs:
Screenshot of the problem:
Log Files from the Bitcoin Client:
Explanation of each field
Bitcoin Client Software and Version Number: The name of the software you are using and the Version number. We will always need to know this information.
Operating System: The name, version number, and bitness of your operating system. This is not always necessary. It is only needed for issues with your Bitcoin Client.
System Hardware Specs: The CPU, RAM, and Hard drive space of the computer that you are using. This is not always necessary. It is only needed for issues with your Bitcoin Client.
Description of Problem: The description of the problem you are having. This is always necessary. We need to know what is wrong.
Any Related Addresses: Any addresses related to the problem you are having. This is not always necessary. We only need to know this if you are having issues with transactions.
Any Related Transaction IDs: Any transaction IDs related to the problem that you are having. This is not always necessary. We only need to know this if you are having issues with transactions.
Screenshot of the problem: A screenshot of the problem that you are having uploaded to an image hosting service such as https://imgur.com. This is not always necessary. It is only needed for issues with your Bitcoin Client.
Log Files from the Bitcoin Client: A link to the log files created by your client uploaded to paste sites such as https://pastebin.com. This is not always necessary. It is only needed for issues with your Bitcoin Client. Not all software have options for exporting log files. If the log file is too large, just paste as much as you can from the bottom of the file.
Examples
The following are two example reports. The first example is one for a software client issue. The second example is for a transaction issue.
Quote from: Example 1
Bitcoin Client Software and Version Number: Bitcoin Core 0.13.1
Operating System: Windows 10 64-bit
System Hardware Specs: 4.0 GHz Quad Core CPU with 8 GB RAM and 50 GB free hard drive space.
Description of Problem: Bitcoin Core seems to be stuck while synching.
Any Related Addresses: None
Any Related Transaction IDs: None
Screenshot of the problem: https://imgur.com/a/zMnKk
Log Files from the Bitcoin Client: http://pastebin.com/tfqN34DW
Operating System: Windows 10 64-bit
System Hardware Specs: 4.0 GHz Quad Core CPU with 8 GB RAM and 50 GB free hard drive space.
Description of Problem: Bitcoin Core seems to be stuck while synching.
Any Related Addresses: None
Any Related Transaction IDs: None
Screenshot of the problem: https://imgur.com/a/zMnKk
Log Files from the Bitcoin Client: http://pastebin.com/tfqN34DW
Quote from: Example 2
Bitcoin Client Software and Version Number: Electrum 2.6.4
Operating System: Ubuntu 16.10 64-bit
System Hardware Specs: N/A
Description of Problem: I received a transaction several hours ago and it still has not confirmed
Any Related Addresses: 16mT7jrpkjnJBD7a3TM2awyxHub58H6r6Z
Any Related Transaction IDs: 4b54637c43beba0eae0cb0a8e139da3e170a941978d47aa5a37b17ff854939c1
Screenshot of the problem: N/A
Log Files from the Bitcoin Client: N/A
Operating System: Ubuntu 16.10 64-bit
System Hardware Specs: N/A
Description of Problem: I received a transaction several hours ago and it still has not confirmed
Any Related Addresses: 16mT7jrpkjnJBD7a3TM2awyxHub58H6r6Z
Any Related Transaction IDs: 4b54637c43beba0eae0cb0a8e139da3e170a941978d47aa5a37b17ff854939c1
Screenshot of the problem: N/A
Log Files from the Bitcoin Client: N/A
If you have any issues with getting any of these fields, still make your help request post and state that you have issues with getting the information for the fields that you have issues with. Users here will guide you on how to get it.
This format can change and evolve as it is used and other users comment on it.
Jump to: