kb:bestpractices:documentation
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | |||
| kb:bestpractices:documentation [2024/07/02 15:36] – joerg.hampel | kb:bestpractices:documentation [2025/05/19 14:59] (current) – manuel.sebald | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| <WRAP center round tip 100%> | <WRAP center round tip 100%> | ||
| **For generating documentation from your LabVIEW code, make sure to check out the [[kb: | **For generating documentation from your LabVIEW code, make sure to check out the [[kb: | ||
| + | </ | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ===== Project Documentation ===== | ||
| + | |||
| + | Project specific documentation shall be included in the Git repository under the folder ''/ | ||
| + | |||
| + | |||
| + | ==== Tooling ==== | ||
| + | |||
| + | For all types of diagrams, we use the free and for all platforms available tool [[https:// | ||
| + | |||
| + | Online tools that work in the cloud (e.g. Canva, MS365, ...) shall be avoided because of security and confidentially issues. | ||
| + | |||
| + | <WRAP center round note important 100%> | ||
| + | **Do not store confidential customer data in untrusted cloud services!** | ||
| </ | </ | ||
kb/bestpractices/documentation.1719934564.txt.gz · Last modified: 2024/07/02 15:36 by joerg.hampel