Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Post History

60%
+1 −0
Q&A How to effectively document a product composed of complex microservices?

I have a highly flexible software product consisting of a series of loosely coupled microservices. Each component is effective at a single job, but may be dependent on inputs from other services. I...

1 answer  ·  posted 7y ago by Jason Fox‭  ·  last activity 5y ago by System‭

#3: Attribution notice added by user avatar System‭ · 2019-12-08T08:02:46Z (almost 5 years ago)
Source: https://writers.stackexchange.com/q/33513
License name: CC BY-SA 3.0
License URL: https://creativecommons.org/licenses/by-sa/3.0/
#2: Initial revision by user avatar Jason Fox‭ · 2019-12-08T08:02:46Z (almost 5 years ago)
I have a **highly flexible** software product consisting of a series of loosely coupled [microservices](https://en.wikipedia.org/wiki/Microservices). Each component is effective at a single job, but may be dependent on inputs from other services. It is expected that additional services will be added later.

The overall product could be considered to be something like the game [Mousetrap](https://www.youtube.com/watch?v=sy840XvnQRA). A practical use case for the whole product could be a complex combination of services. Maybe I have a _ball-rolling-down-stairs_ component, but just documenting the inputs and outputs seems incomplete as only once I combine it with the _kicking-foot_ component and the _dropping-cage_ component does **one possible** overall use case of the product (catching mice) get satisfied.

What is the best way to document such dependent services?

To clarify I'm not just interested in **what** to document. I'd also like opinions on how to split up and structure the documentation, especially as the product gets more complex.

#1: Imported from external source by user avatar System‭ · 2018-02-11T13:22:07Z (almost 7 years ago)
Original score: 11