SSMS Tips and Tricks 3-5: Fixing or improving the online documentation

I mentioned in an earlier post that I think the online documentation is now superior to any version that you can install locally.

I particularly like the way that the online version is cross-version ie: each page covers all supported versions, instead of having a separate page for each version.

But one of the really big bonuses is that you also have the opportunity to change the documentation if you think it’s incorrect or you think it could be improved. Microsoft have placed all the documentation in a GitHub repository and you can change it. Doing so is easier than you might expect.

Let’s look at an example.

I’ve searched for the LEN function in T-SQL and found the page:

Now while I’m reading the page, I see this:

I’m puzzled why that example is specific to AdventureWorks2012. That code would work on all AdventureWorks versions. So, let’s try to change it. At the top of the page, there’s an Edit link.

I’ll click this and I’m taken to the page in GitHub:

Note in the top right-hand corner that I’ve already logged onto GitHub. Also notice the Edit pencil. Now I can’t just directly change this info, so what I do is click this to “fork” the project so that I have my own copy to edit.

Now I can make the change that I want to:

And at the bottom of the page, I explain why:

Then I click Propose file change, and I’m taken to a page that asks me to create a pull request.

GitHub runs some automated checks and makes sure that I’m not suggesting a change that can’t easily be merged.

If I’m happy with the differences shown, I just click Create pull request and again another time. This page is then sent off to the person who is responsible for maintaining the page:

If they agree, your change will be merged in. Either way, you’ll receive emails telling you what’s going on.

If you have added a lot of changes or code, you’ll also receive another email asking you to agree to be a contributor.

This is a great option and once you’re used to it, it’s very easy to do. And if you look at the published page today, you’ll see this change was made!

2025-07-06