Skip to main content

Help yourself if you ask for help

This is a slight modification of a Reddit post I created a few months ago. It was written for Reddit, however the analogy works even if you ask for help anywhere else too.

I have not been on Reddit for long, however I have been watching the posts being submitted. In all fairness, I have a couple of suggestions to you if you need help with something larger than a commandline or suggestion of a command line:

How to ask for help

  1. Always state the goal of the solution. What is the problem you have decided to try and solve. If your solution is to produce output, explain what it should output and what form (console, xml, json, text, csv etc).
  2. How will the solution be executed (as a script, as part of an module or as an function)
  3. If your solution is not working, share the whole script/function included dependency code, not just the line/command/function that is not working.
  4. If you code requires parameters and your code does not include any help/comments on how it works, explain what the parameters are and how you want them to work. Also important to include a section(just a few lines) of required input files like csv/cms/json or if the script is designed to receive input from an operator at the console.
  5. What version of powershell are you targeting and if it is executed on a client/server.
  6. Include error messages you are receiving when executing the code

Also if you manage to:

  1. Write and format your code (all codelines should start with 4 spaces (blanks)) to be rendered nicely)
  2. Avoid using aliases (use full cmdlet names)
  3. Use logical variable names (too long is better than too short, however that is a personal perference). This also applies to parameter names.

You will probably receive a reply to your request more quickly and to the point.

Examples of bad requests:

The googler:

"*Hey, have this powershell/script I found on the internet. It is failing on this line <insert line her> with this error..... Please help...*"

The csv lover:

"*Hey, I have this huge script that requires input from 2 csv files. It works when I input the values manually, but not when I pipe in the csv files with the import-csv cmdlet.....*"

Free ride lover:

"*Hey, I have this huge problem and I am thinking of learning powershell. I need to <insert required solution here>.... Please show me a script that can do this...*"

Ask and you shall receive, if you ask the right way

You will need to put some work in to your request, however in the long run you will most likely receive a reply sooner rather than later and it will provide you with a suggestion that is closer to the answer you where looking for. This is just my prediction, it is not an universal truth.

Consider this my 2cc. I love to help when I have a clear understanding of the issue and we can discuss options related to your requests.




Popular posts from this blog

Developing PowerShell modules for REST APIs – Part1

Over the years I have developed different PowerShell modules for different web APIs. I thought it would be a good idea to write a 2 series post about how you could go about to do this. This will be a 2 part blog series where we will run through the entire process of building a module for a REST API. I will try my best to keep this as simple as possible and leave more advanced stuff for a follow up post if the interest is there.What you needDepending on your experience with source control and PowerShell in general, you might want to use GIT or some other software repro for the code. In addition we are going to create a test REST API using the splendid UniversalDashboard PowerShell module created by Adam Driscoll. It is available on the PowershellGallery. Other prerequisites are built-in to Powershell. I will assume that you will be following along using at least PowerShell version 5 or greater.
What is HTTP metods for REST API.The primary or most common HTTP verbs used are POST, GET, PU…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.

Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Developing PowerShell modules for REST APIs – Part2

This is part 2 of the REST API blogpost. In part1 we successfully setup two REST API endpoints using the UniversalDashboard PowerShell module. In this part we are going to create a simple module that support some CRUD operation against our API. As we are trying to keep things as simple as possible, we will not use any fancy framework (like Plaster) to build our module. We are also going to skip a very important step you should familiarize yourself with, Pester tests. Lets get to it.

The moduleWe will build a module called FilesAPI. The module folder will look like this:

In the functions folder I have already added the 2 helper functions from part 1, Get-AuthorizationHeader and ConvertTo-Base64. The other folders are just placeholders for important stuff like classes, private functions that you do not want to make available for the module consumer and tests for Pester tests. For such a small module that we are going to create, one could argue that it is much easier to just add the functi…