It doesn’t matter if you’re a junior or senior dev, it doesn’t matter your experience, many times we find a solution of a problem when we try to explain the problem to someone else when we ask for help.
I took this idea from the concept of programming frameworks. One, of many, benefits you’ve with a framework is the speed from other programmers to jump in quicly to collaborate on a project. You remove the barrier created of not knowing how to communicate between different parts. This small "questions" framework has the same purpose.
Having this idea in mind, implementing a framework to ask for help is a good starting point to improve our workflow.
Explain the failure path. What are the steps you take to reproduce the problem
We work on different things, even if we’re working on the same application, our tasks may be on different features. The best way to ask for help is to have an easy way (in terms of information) to reproduce the context of our issue.
What to do expect to happen?
Explain what we expect from our task is no always so simple as we may thing. I always remember that line from Philadelphia movie -yes, I’m not 20 years old any more:
Explain this to me liike I’m a two year old
What actually happens?
Sometimes is not so clear what’s going on, but any information we can provide from our current problem it will help to solve it. This information should highlight whats different from whats we expect.
A good way to think about this is like if we are following a recipe, we describe step by step how things are going and we describe on each steap we found something different, how is that different from what we need to happen.
Full error text / output
Many times having the output of the problem provides a lot of information and it helps to solve it.
This is only an intruduction, an idea I have in my mind. I’ll provide more on this in the future. For now, I need to run some experiments implementing this and see how it goes