Code map
Posted by 2thick2fly@reddit | learnprogramming | View on Reddit | 5 comments
I know this question might not be exactly for this subreddit, but I think since it is related to learning in some way, there might some good insight.
What I am trying to do is to create a code map of my repo (python) to ease junior devs into it, but I am stuck.
The code structure is workflow-based, where the top layer is the business process step-by-step. The orchistrator calls each step - which then calls the necessary module(s) - and when a step is finished, the orchistrator calls the next step. A bit oversimplified, but you get the idea.
Any ideas for tools that can do that?
PS: I tried AI, but it was just laying everything out either horizontally or vertically in mermaid, which did not make it visually pleasing.
Inn0centDuck@reddit
You want to create a sequence diagram ?
Yoosle@reddit
Make a flow chart. Your explanation of the code makes sense to me. Connect the processes and show how they are related to each other.
aanzeijar@reddit
If you can't even explain it, then you can't describe it in writing either. This is quite common actually. Get someone who has never seen your code, explain to them what part does what, record the entire thing, and then edit that down.
2thick2fly@reddit (OP)
That's exactly the part I am trying to avoid 😁
aanzeijar@reddit
Why do you want to avoid that?