poc:documentation-guidelines

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

poc:documentation-guidelines [2025/07/28 12:42] – created fabriciopoc:documentation-guidelines [2025/07/28 12:43] (current) – [Environment & Setup] fabricio
Line 20: Line 20:
 The scope is up to the judgement of the team. The scope is up to the judgement of the team.
  
-Recommendations for projects with hardware:+Suggestions for projects with hardware:
  
   * List of hardware-parts (e.g. Raspberry Pi 3, ...)   * List of hardware-parts (e.g. Raspberry Pi 3, ...)
Line 26: Line 26:
   * Additional notes on setup.   * Additional notes on setup.
  
-Recommendations for projects with software:+Suggestions for projects with software:
  
   * Programming Language & Package Versions, Docker image, ...   * Programming Language & Package Versions, Docker image, ...
Line 32: Line 32:
   * Git Repo (Code, Dockerfiles, Configs, ...)   * Git Repo (Code, Dockerfiles, Configs, ...)
  
-Recommendations for projects with data: +Suggestions for projects with data: 
-  * Original data source + Time+  * Data source and when it was acquired/downloaded  
   * Description of changes to data, ideally with scripts + dependencies in git repo.   * Description of changes to data, ideally with scripts + dependencies in git repo.
  
  • poc/documentation-guidelines.1753706538.txt.gz
  • Last modified: 2025/07/28 12:42
  • by fabricio