Untitled attachment

One of the hardest things to do is to keep a complete conceptual model of the software you’re building in your mind at all times (if you hear people talking about “getting into the flow”, a lot of that is about constructing or reconstructing that model in your mind before you’re able to be productive in making changes to an existing piece of software).

There are lots of things we can do to make this easier.

Modularisation is one of those things (so we don’t necessarily have to keep everything in our head at the same time).

A test harness is another (so that when we invariably fail to keep everything in our heads and make a change over here that breaks something else over there, we are alerted to it as quickly as possible).

But documentation also plays an important part – especially when you’re bringing someone new onto the team or bringing yourself back to the team after a week or two away. And documentation that helps you build a conceptual model of the software in your head is usually one of those things that’s lacking.

So, to try and address this in Kitten, I’ve started to write – in addition to the (currently, woefully inadequate) reference guide¹ and tutorials² – a technical manual:

https://kitten.small-web.org/reference/technical-manual/

Think of its as the equivalent of those old-school factory service manuals you would get for cars and even computers, back in the day.

Eventually, you should be able to read the technical manual to form a conceptual model of how Kitten works. Hope you find it useful.

:kitten: 💕

¹ https://kitten.small-web.org/reference/
² https://kitten.small-web.org/tutorials/

#Kitten #SmallWeb #documentation #web #dev #HTML #CSS #JavaScript #NodeJS

Public

Notices where this attachment appears