SOP on PM: a basic template for successful questions

---

Purpose:

To provide a 'thought' template (or form/checklist) that `concisely' guides a SOPW participant through preparing to post a question on said SOPW.

How do I post a question effectively? is one of the places to really dig in to writing a good post. This hopefully serves the purpose of getting you to think about all that good advice.

---

What I am working on(brief overview)

• Platform
• OS
• Integrating with...(excel, libreoffice...etc...)
• Perl Version
• Using (module::name::?) if appropriate
• What I want for output
• What I am using for input
• Combine this with 'What the problem is' below and you will have a good start to answering How do I compose an effective node title?

What the problem is

• First, ensure this is not XY Problem
• Post relevant code (use code tags, 'code' or 'code')
• Keep to relevant portions.
• Make sure it compiles (or would if complete, copy exactly what you have(not data though))

What you have tried

• If you provide some of the above, it will prove you did something and are not looking for free coding service.

Errors you're are getting ... if you already tried the following: (helpfully suggested by LanX)

• use warnings;
• use strict;
• use diagnostics;
Then:
• Copy/paste the errors in code tags with the rest of your post.

My input

• Include __DATA__ block or at least a few lines of the input file(also in code tags, 'code' or 'c')
• If it is a known format like JSON or TNNAME.ORA, mention that.
• Clean it for security purposes, but don't screw it up! Original size, character counts etc... are important!

What it is you don't understand about solving the problem

• I don't know how to format...
• I don't understand the data structure...
• I don't understand this code at line...
• ...

---

Further excellent suggestions regarding the subject matter from other PM's:

• SSCCE a bit more detail amount communicating about code. Provided by tobyink
• Interesting discussion about the subject pointed out by GrandFather
• Too Detailed, Too Soon A good point about 'approach' questions by sundialsvc4
• Re: Thought(s) about SOP questions... by sundialsvc4

---

If you manage to get at least one clear, concise statement about what you are trying to solve from each those first three main categories, you are likely to get pretty good, pretty quick help. If you can't do that, go back and ask yourself those questions in the first three categories, get them clear in your head, then write them. The clarity of your question might lead you to your own answer, and if not, it will surely help those attempting to assist you...

No one is going to beat you up for not knowing how to state every question above. Hell, my posts have sadly not even followed this format! They will from now on! But if you give it half a shot your results are going to be a lot more satisfying, and the questions you get about your question for clarification will help you better define your question, and therefore your solution. Really, this is all covered in [id://174051>, but here is some of it again...

Hope that is helpful...

---

A solution is simply a well stated problem...otherwise the problem is not a problem, it is a fact...

Updates:(newest first)
• Added a few select links
• Clean up, re-order in more logical step by step sequence base on other successful SOP postings(based on my opinion
• Added link to suggestion, Added 'Purpose Statement'
• Clean up, clarify Title
• Added reference to XY problem
• Added this update list
• Added suggestions from subsequent posters

ToDo
• Provide example of Excellent Question
• Provide example of Marginal Question
• Provide example of Poor Question