5 votes

How to effectively document a product composed of complex microservices?

What you just described is almost every Web based REST API. Those are nothing more than a series of calls, sometimes into the hundreds or thousands, that the developer has to put into a meaningful ...
ForEachLoop's user avatar
4 votes
Accepted

How to effectively document a product composed of complex microservices?

I've worked on a few doc sets like that. While API reference documentation is one case where you see this problem, the problem occurs at the "module" level too. Your question is about microservices, ...
Monica Cellio's user avatar
4 votes

How to effectively document a product composed of complex microservices?

Much depends on how the microservices are packaged for the consumer. If users can mix and match, you need to document each microservice separately, but include “meta” information for the user to ...
Sharon M's user avatar
  • 738
2 votes

For HTML documentation sets, are there meaningful guidelines for topic length?

This is not based on studies. It is instead just the subjective experience of plainly and painstakingly having to read through documentations of different sorts throughout the years. Documentation is ...
NofP's user avatar
  • 10.6k
2 votes
Accepted

How do I mix linear and non-linear "choices" in an interactive novel?

It depends on the medium. I just looked through the example you provided in the comment section and it seems to me like the non-choices basically do the same that the normally limited space in a text ...
Secespitus's user avatar
  • 5,686

Only top scored, non community-wiki answers of a minimum length are eligible