DEV Community

Discussion on: Documentation structure

Collapse
 
functor profile image
Santana16

Great post! thank you. Do you think having visual representation of the source code in form of diagrams can help to reduce the amount of text developers have to read thru? If there were a tool that would automatically creates architecture diagrams from your source code, you think that would be more helpful for developers to understand the nature of this code and it's underlying logic?

Collapse
 
chrischinchilla profile image
Chris Chinchilla

Well, yes, but not images of code, as then people can't copy and paste.

Maybe images of output is useful, but it depends on what that output is.

I think there are diagrams that can create architectural diagrams, and again, if the code example needs it, they might be useful, likely for quite complex applications.

Images explaining loops and algorithms etc might be useful though for sure.