About the HR Project Documentation
In this repository there is an instance of a framework proposal for the documentation of systems built using microservices, as proposed in the paper Microservices Documentation Proposal1. Therefore the navigation represents an instance in a case study of the HR system, in which it was tested for framework validation in the article.
In this framework, the documentation is build according to the desired view. The following structure describes how the structure of the documents in this system is arranged according to the strategy of the views:
Solution- Documentation of the software design solution level.Modules- Documentation of individual architecture modules.Interface- Documentation of module interfaces and system interactions.
-
Insert article full text link. ↩