Good ressources for writing tutorials

micro:bit micro:bit extensions
1

Hi everyone! My name is Pascal. I recently started to extend the existing NeoPixels extension (https://github.com/PasAlt/pxt-neopixel-matrix-extension). I’m now trying to write some tutorials for it (https://github.com/PasAlt/neopixel-tutorial).

I’m trying to get a hold on how to write good Tutorials and I stumpled upon the following repo on github: https://github.com/microsoft/pxt-tutorial-sample . Unfortunately those parts seem to be abandoned and, at least for me, it won’t start anymore.

Then I tried to get myself an overview here: https://makecode.com/writing-docs/tutorials/basics but I found it not that helpful. On my browser this renders weirdly.

Does any one else have a better and complete ressource on how to write tutorials for MakeCode?

4 Likes
2

welcome to the forums @PasAlt

1 Like
3

Welcome, Pascal! The main documentation page for writing tutorials is found here:

Take advantage of the tutorial tool if you haven’t done so already.

https://makecode.com/tutorial-tool

The best way to learn how to write tutorials, though, is to view the code for the existing tutorials. Find a tutorial from the MakeCode for micro:bit home page, and then look over the code for the syntax.

I’ve started writing a “tutorial on tutorials.” It’s incomplete, but it has some information on the planning process.

Also, I have to plug our friend Ryan’s session that he gave at last year’s ArcadeCon!

Please be sure to ask questions! There are several of us here who write skillmaps and tutorials. We’ll be happy to help.

1 Like
4

Thanks everyone for that warm welcome!

Thanks for those plentyful ressources! I missed that there is a top page for tutorials and another one for writing docs in general: https://makecode.com/writing-docs. I was especially looking for the Macros option which is only linked in the top page about writing docs.

1 Like
5

hello fellow coder, welcome to the forms