Groups > comp.lang.python > #197098

Re: How to go about describing my software with a component diagram?

From	Thomas Passin <list1@tompassin.net>
Newsgroups	comp.lang.python
Subject	Re: How to go about describing my software with a component diagram?
Date	2024-12-24 16:18 -0500
Message-ID	<mailman.26.1735087601.2912.python-list@python.org> (permalink)
References	<CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com> <CAGJtH9STnx2krCYs=6rEMNnc5kHNity-sWZiKWqbuMweRHejVA@mail.gmail.com> <a7e5db71-ec6e-2625-a257-352303ff5e8a@gmail.com> <CAGJtH9QyXW64qnB2sSz8ZSp8x+dsyEH-_PvSmmTN1dR-wbPEQQ@mail.gmail.com> <0c3c9d66-39a2-491c-9e86-9c9cd6df814a@tompassin.net>

Show all headers | View raw

On 12/24/2024 3:42 PM, marc nicole via Python-list wrote:
> it is here https://i.sstatic.net/ykk5Wd0w.png

This diagram does not make much sense to me:

1. What is the purpose of the diagram and who is it intended for?
2. A module and an algorithm are different kinds of things, yet they are 
connected together as if they are the same.
3. Connecting lines should always be labeled, preferably with direction 
indicators that augment the labels.  Otherwise the viewer has to imagine 
what the nature of the connection is.
4. It's better if different kinds of things look different.  That could 
be a different box shape, a different color, or some other visual 
difference. Here I am thinking about the box labeled "Algorithm". We 
can't tell if it is intended to mean "A library module that implements a 
certain algorithm", "An algorithm that the three components cooperate to 
implement", "The top-level module for computing an algorithm that 
contains three modules", or something else.

Back to comp.lang.python | Previous | Next | Find similar

Thread

Re: How to go about describing my software with a component diagram? Thomas Passin <list1@tompassin.net> - 2024-12-24 16:18 -0500

csiph-web