general:project_documentation

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
general:project_documentation [2025/07/21 10:45] – ↷ Page name changed from general:documentation to general:project_documentation rekonasgeneral:project_documentation [2025/07/22 08:24] (current) patrick.kahr
Line 19: Line 19:
 We keep this type of documentation in a Wiki as it can be quickly edited. We keep this type of documentation in a Wiki as it can be quickly edited.
  
-TODOOutline our use of Wiki(s) in greater details.+====== Our Wikis ====== 
 + 
 +We organize content into separate department-specific wikis: 
 +  * [[https://wiki.ops.rekonas.com|Operations]] 
 +  * [[https://wiki.rd.rekonas.com|Research & Development]] 
 +  * [[https://wiki.prod.rekonas.com|Production]]
  
 ===== Project-specific Documentation ===== ===== Project-specific Documentation =====
Line 68: Line 73:
  
 **Bootstrapping**: When starting a new project, the workflow in general looks like this: **Bootstrapping**: When starting a new project, the workflow in general looks like this:
 +
 +{{:general:workflow.png?400|}}
 +
   -   Iterative project brainstorming (organized by project owner)   -   Iterative project brainstorming (organized by project owner)
   -   Project Setup (Docs, Code, Hardware, other dependencies)   -   Project Setup (Docs, Code, Hardware, other dependencies)
Line 79: Line 87:
  
 **Project organization summary**: Provide a short summary of project documentation setup (visual and written) that can serve as an inspiration for future projects. **Project organization summary**: Provide a short summary of project documentation setup (visual and written) that can serve as an inspiration for future projects.
- 
-{{:general:workflow.png?400|}} 
  
 ==== Maintenance ==== ==== Maintenance ====
Line 131: Line 137:
  
   * Gitea Template: https://code.rekonas.com/rekonas/docs-template   * Gitea Template: https://code.rekonas.com/rekonas/docs-template
-  * Online Version: https://docs.rekonas.com/template/latest/+  * Online Version: https://docs.rekonas.com/template/
  
-Before starting a new project, it is recommended to have a look at the Tutorial: https://docs.rekonas.com/template/latest/Help/Tutorial/+Before starting a new project, it is recommended to have a look at the Tutorial: https://docs.rekonas.com/template/0.1.2/Help/Tutorial/
  
  
  
  • general/project_documentation.1753094739.txt.gz
  • Last modified: 2025/07/21 10:45
  • by rekonas