GitHub user zyratlo added a comment to the discussion: Architecture diagrams: how much detail and how to keep current?
1. From a project management perspective, I think **A** is enough. I recognize that too many diagrams, especially highly detailed ones, can drift and become inaccurate very quickly and will require the burden to maintain. And since agents can effectively extrapolate finer details by looking at the source code, highly detailed diagrams may not be as needed anymore for human developers. From a personal perspective, I like **B** more since I like having detailed diagrams, but that is just my personal preference. 2. Regardless of if we choose to have detailed diagrams or not, I think that whoever introduces the feature first creates the diagram. If another developer changes the architecture in a later PR, then they should also update the diagram accordingly. 3. Different audiences would want different diagrams. For github issues and PRs, detailed diagrams and ER diagrams are useful. Compared to social media or blogs, depending on their content and purpose it can be written for developer or non-developer audiences, so it will vary. GitHub link: https://github.com/apache/texera/discussions/8609#discussioncomment-18520967 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
