A bit more documentation

Given that last weekend's sessions introduced a new type of observing to my logs I felt the need to add a new markup item to my logging system. While doing that I realised that I had no definitive list of all the forms of markup that could be used in the notes for a session or an observation.

So, this morning, I created the list in the (still incomplete) documentation for the file format I use. I've also created a page for each type of markup; each page gives a brief description of the purpose of the markup, the syntax of the markup and also gives an example or two of the markup in use.

I'm glad I finally got around to doing this. From now on I won't need to go looking at my source code or old logs to remind myself how a specific markup item works.

No comments: