Wednesday 22 March 2017

NEAT - Application "Framework" - How to explain it?

Hi,I and a few coworkers have put together an application framework that basically is supposed to replace all the things you would constantly build again for no apparent reason (setting up sessions / user auth / crud routes / permissions / rendering for frontend / routes for apis / exports ... all the nice things) now this is already being used by us internally but i want to improve the documentation of this over the next few weeks.So my question here would be if anyone could give me some hints how to best start a Documentation / Tutorial of sorts for a really big system. Currently it consists of the following git repos (& npm packages)http://ift.tt/2msPky2 of them are not even remotely done but some are getting more stable every day and can already be used very efficiently.The thing is that just explaining for example the frontend module can take up to 2 hours with the person sitting next to me, not because its that hard to learn just because there is an absurd amount of possibilities ...A lot of them also interconnect and give other modules more features (neat-projection is the prime example of this)So where should i start explaining what it can do for you ? Would you rather have a simple backend with an api that could be used by any kind of app / SPA, or an example how this can be used to make a simple blog?I'm happy for any help on how to get the Documentation / Getting started articles on this started... Also if anyone would like to try it or help with some sort of screencast or something we could do, please pm me :)Cheers, NexumTL;DR: Big big framework int he works, need help on where to start explaining something like this, what kind of examples would be good and so on

Submitted March 22, 2017 at 02:47PM by Nexum666

No comments:

Post a Comment