this post was submitted on 05 Aug 2023
16 points (86.4% liked)
Programming
17313 readers
216 users here now
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities [email protected]
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
As others said, in-depth design is often skipped, especially if the dev team started very small. Sounds like your intuition is right, though - the lack of design bit them on the ass when they realized they missed a part.
I have also been laughed at when I suggested a UML diagram in the past. However, it is helpful. For more visually oriented people even more so.
I'd suggest to go ahead and do it, unless your boss is adamant that it is a waste of time. When they see the result they might be happy.
EDIT: writing it out, I swear, makes no sense at all
Oh I'm not the one who designed the DB, I just implement the endpoints and stuff for this particular project (my role is that of a FE dev).
I asked cause:
I understand the predicament you are in, but I don’t know that you’ll get very far with your current approach.
The actual artifact you need from your collaboration is the list of API endpoints and the structure of what the request and response payload will look like for each one. This doesn’t need to be UML, it can literally be a text doc.
By asking for something highly structured that the other people may not know how to make, or do not have the tools to make, you’re putting them in a position where they have to acknowledge that they don’t know how to do something, or causing them to do work that they don’t value. Once you’ve had success on a team and developed trust/respect, you can push for adding process/tooling, but if you’re new to a team, you really have to work with what you’ve got.
Either of you could write a simple doc outlining the API and then collaborate on that (it’s also much easier to actually comment/collaborate on than a diagram, anyway).
I think you misunderstood, I'm the one implementing the API and writing the queries - alongside a coworker that doesn't have BE experience. I'm not the one who made the DB though, neither is he, and the design is not very reliable