Friday, May 15, 2020

Why diagrams are critical to your open source project documentation

Abstract connections between dots

If you've ever visited a project on GitHub (for instance) with the intention of understanding how it fits into a larger system, you'll recognise the sigh of relief you experience when you find a diagram or two on (or easily reached from) the initial landing page. This is an article about the importance of architecture and specifically about the importance of diagrams.


read more

from Opensource.com https://ift.tt/2ApOf1G

No comments:

Post a Comment

Please do not enter any spam link in the comment box.

How I channel my inner Star Trek character at work

In a recent Twitter thread , I self-identified as "some days Deanna, some days Riker." Others shared their own "Star Trek Sp...