Git Product home page Git Product logo

systems-diagrams's Introduction

The Ins & Outs of Systems Diagrams

You've identified all the pieces. You've talked with all the stakeholders. You've taken copious notes. You've even structured a wiki that could help your team realize all the benefits of a thriving documentation repository. It seems like such a win! But...the system is so big--there are too many details for one person to put in the wiki, and even if you could--what if no one uses it. Somehow, the whole team is going to have to get engaged with the documentation.

Detachment from documentation is common for teams working on technical projects, but there is a tool that can help--the Systems Diagram. Readers of this repo will see examples of how a collaboratively-built Systems Diagram can encourage a team to care more about documentation. It covers how to facilitate a Collaborative Design Session so everyone has a deeper understanding of the system and feels more compelled to keep documentation up to date. There will be a showcase of good and "less helpful" Systems Diagrams along with some key takeaways about how to connect this work to other documentation, workflows, and more! Keep reading to amplify your Diagramming Skills or simply to enjoy the captivating ways a Systems Diagram can illustrate meaning.

systems-diagrams's People

Contributors

lee-coates avatar

Stargazers

Lee Coates avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.