Best practices for documenting your microservices/sproc project?

This page summarizes the projects mentioned and recommended in the original post on /r/dotnet

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • jaeger

    CNCF Jaeger, a Distributed Tracing Platform

  • Besides documentation, if you don't know what connects with what, I'd suggest adding the observability to your services (not sure if https://opentelemetry.io/ is already completed for .NET, or it's still better to use e.g. https://opentracing.io/). Anyway, at least use the tracing https://www.jaegertracing.io/ or built-in Azure App Insights distributed tracing to get a nice overview in a form of a graph what are the service dependencies, potential bottlenecks, coupling, etc.

  • opentracing-javascript

    Discontinued OpenTracing API for Javascript (both Node and browser). 🛑 This library is DEPRECATED! https://github.com/opentracing/specification/issues/163

  • Besides documentation, if you don't know what connects with what, I'd suggest adding the observability to your services (not sure if https://opentelemetry.io/ is already completed for .NET, or it's still better to use e.g. https://opentracing.io/). Anyway, at least use the tracing https://www.jaegertracing.io/ or built-in Azure App Insights distributed tracing to get a nice overview in a form of a graph what are the service dependencies, potential bottlenecks, coupling, etc.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • opentelemetry-specification

    Specifications for OpenTelemetry

  • Besides documentation, if you don't know what connects with what, I'd suggest adding the observability to your services (not sure if https://opentelemetry.io/ is already completed for .NET, or it's still better to use e.g. https://opentracing.io/). Anyway, at least use the tracing https://www.jaegertracing.io/ or built-in Azure App Insights distributed tracing to get a nice overview in a form of a graph what are the service dependencies, potential bottlenecks, coupling, etc.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts