2 ms·
Firstly make sure you split the docs into the 4 categorise others have mentioned. For internal use, a great reference is usually where you want to get started.
by gervwyk 6y ago
Firstly make sure you split the docs into the 4 categorise others have mentioned. For internal use, a great reference is usually where you want to get started. After that you should be able to put together an explanation of the bigger concepts. If you need to draw diagrams, Lucidcharts is really easy to get the job done.
Just sharing what worked for us.
Lowdefy docs [1] was written in Lowdefy. It makes is really simple to get markdown on a page. Would also be possible to write a script to generate the docs from code. But as far as I can tell, the code is not documented either. For the Lowdefy blocks we only write JSON-schemas but then convert that with a simple script to what you see in the docs.
[1] - https://docs.lowdefy.com https://docs.lowdefy.com