Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
training:block_diagrams [2016/02/29 02:51] kluong |
training:block_diagrams [2016/02/29 03:34] kluong [Examples] |
||
---|---|---|---|
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: | ||
+ | |||
* **Figure out what information you want to convey to the audience** | * **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 the overall system? | ||
* Are you describing an algorithm? | * Are you describing an algorithm? | ||
* Are you describing a workflow? | * Are you describing a workflow? | ||
- | * You may need multiple block diagrams in your presentation, or you might need less. | + | * Do you need multiple block diagrams? |
- | * **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 | + | * **Look through some of the [[ .:block diagram examples:start]]** |
- | * **Include enough text to give your audience context** | + | * Which one is closest to what you're trying to aim for? |
- | * Label communication types or voltage/current measurements | + | * Do any of them fit what you're trying to describe? |
- | * **Make sure that you're representing things correctly** | + | * Look through the other project's presentations to look at their block diagrams |
- | * Is there a chance for misintrepretation? | + | |
+ | * **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? | ||
* **Get comments/feedback early and revise** | * **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 | ||
+ | ===== Tools ===== | ||
- | Here are a few tools you can use: | + | 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 | * Word | ||
Line 26: | Line 40: | ||
* Powerpoint | * Powerpoint | ||
* Google Presentations | * Google Presentations | ||
- | * Draw.io | + | * [[ https://www.draw.io/ | Draw.io ]] |
- | + | ||
- | ===== Guides ===== | + | |
- | + | ||
- | * https://www.smartdraw.com/block-diagram/ | + | |
- | + | ||
- | + | ||
- | ===== Examples ===== | + | |
- | + | ||
- | * http://cdn.upverter.com/static/blog/blockdiagram.jpg | + | |
+ | ===== Reading ===== | ||
+ | - https://en.wikipedia.org/wiki/Block_diagram | ||
+ | - https://www.smartdraw.com/block-diagram/ | ||
- training/block_diagrams.txt
- Last modified: 2021/09/19 21:59
- (external edit)