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

the purpose of the diagram is to convey a minimalistic idea about the
structure of the code/implementation/software

Le mer. 25 déc. 2024 à 01:49, Thomas Passin via Python-list <
python-list@python.org> a écrit :

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.
>
--
https://mail.python.org/mailman/listinfo/python-list
>