#Planning And Documenting A Backend Project

8 messages · Page 1 of 1 (latest)

cedar needle
#

I plan to make a project.
The project will have a number of interacting microservices.
I want to know how to get started planning the architecture of said project. I am already familiar with some architecture concepts but, I am primarly asking about how to plan and document the project.

What applications to use (linux, open source)
I am currently considering to use ubmbrello and dia to document information about the backend's components. But, I don't know If I should follow a specific uml standard or just draw some shapes without caring for any uml spec?

How much planning is reasonable before I get started implementing those microservices?

merry coyoteBOT
#

This post has been reserved for your question.

Hey @cedar needle! Please use /close or the Close Post button above when you're finished. Please remember to follow the help guidelines. This post will be automatically closed after 300 minutes of inactivity.

TIP: Narrow down your issue to simple and precise questions to maximize the chance that others will reply in here.

stuck plinth
#

I'd recommend not drawing diagrams for the sake of drawing diagrams

#

If you feel like something isn't obvious, focus on that

#

But what I would recommend to properly plan and document beforehand is the interfaces of your microservices

#

What endpoints do the microservices provide? What data can be passed to them? What responses do they yield? What protocols/format are you using?

#

you should probably know what components you have and how they interact with each other