I am working as a software engineer turned team leader in a large software company. One of my areas of strength is node.js, and we are in the process of moving a lot of our services to separate node.js services, which is proving to be very successful so far.
However, I am supposed to stop day to day development of small node.js services, and simply lay down a proper specification, so that one of my team members can work on the actual code.
I am aware of tools like UML, but I don’t think they apply to a system with apis built with node.js/express. I have made a few flowcharts, but my seniors want me to be very complete with the spec, down to each implementation detail.
How I can achieve this? Should I design objects in UML and make my developers make javascript objects which can be used in express routes?
5
I created a module that generate class diagram for javascript/node/html/css. Its based on the “WAE” extension of UML. Its called wavi. For javascript, function,variable and use of other modules are automatically recognized. You can use it for documenting your application.
https://www.npmjs.org/package/wavi
0
Apart from the obvious text description, I think that a sequence diagram would do the job. Any more specific and You might as well write the code.
Sequence diagrams
2