Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
training:block_diagrams [2016/02/29 02:49] kluong |
training:block_diagrams [2021/09/19 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Block Diagrams ====== | ====== Block Diagrams ====== | ||
| - | Block diagrams are important to display information in a visual way to an audience. Block diagrams have the potential to display more information in a more condensed form that just text alone. | + | Block diagrams are important to display information in a visual way to an audience. Block diagrams are typically used for higher level, less detailed descriptions that are intended to clarify overall concepts without concern for the details of implementation. |
| + | |||
| + | Contrast this with the schematic diagrams and layout diagrams used in electrical engineering, which show the implementation details of electrical components and physical construction. | ||
| + | |||
| + | ===== Workflow ===== | ||
| Depending on what you're trying to describe the specific elements can be different but here are some points you should follow: | Depending on what you're trying to describe the specific elements can be different but here are some points you should follow: | ||
| - | * Make sure you outline relationships well | ||
| - | * For hardware - how are the hardware components interconnected? | ||
| - | * For software - you might be describing how your program logically flows from one state to another | ||
| - | * Include enough text to give your audience context | ||
| - | * Label communication types or voltage/current measurements | ||
| - | * Make sure that you're representing things correctly | ||
| - | * Is there a chance for misintrepretation? | ||
| - | * Get comments/feedback early and revise | ||
| + | * **Figure out what information you want to convey to the audience** | ||
| + | * Do you even need a block diagram? Why? | ||
| + | * Are you describing the overall system? | ||
| + | * Are you describing an algorithm? | ||
| + | * Are you describing a workflow? | ||
| + | * Do you need multiple block diagrams? | ||
| - | Here are a few tools you can use: | ||
| - | * Word | + | * **Look through some of the [[ .:block diagram examples:start]]** |
| - | * Google Draw | + | * Which one is closest to what you're trying to aim for? |
| - | * Powerpoint | + | * Do any of them fit what you're trying to describe? |
| - | * Google Presentations | + | * Look through the other project's presentations to look at their block diagrams |
| - | * Draw.io | + | |
| - | ===== Guides ===== | + | * **Outline the blocks that you need to describe** |
| + | * What are your blocks going to be in this case? Hardware components? Libraries? Software States? | ||
| + | * What are the connections between your blocks? | ||
| - | * https://www.smartdraw.com/block-diagram/ | + | * **Get comments/feedback early and revise** |
| + | * Do not work on this the night before | ||
| + | * It's important to get some feedback from either the leadership team or another team | ||
| + | * Look at something else and come back to the block diagram after a while | ||
| + | ===== Functional Block Diagram ===== | ||
| - | ===== Examples ===== | + | Functional block diagrams describe what your system's functions are and not necessarily how it's implemented. They very concisely describe the behavior of your system and is a good primer to describe your design. |
| + | ===== Tools ===== | ||
| - | * http://cdn.upverter.com/static/blog/blockdiagram.jpg | + | Listed below are some tools that you can use to design your block diagram. Regardless of the tool you use, the content should be first on your priority list - try and few tools and see if they can help you achieve the objective that you want. |
| + | |||
| + | * Word | ||
| + | * Google Draw | ||
| + | * Powerpoint | ||
| + | * Google Presentations | ||
| + | * [[ https://www.draw.io/ | Draw.io ]] | ||
| + | ===== Reading ===== | ||
| + | - https://en.wikipedia.org/wiki/Block_diagram | ||
| + | - https://www.smartdraw.com/block-diagram/ | ||