SRRC Wiki

Service Robotics Research Center
at Ulm University of Applied Sciences

User Tools

Site Tools


how-tos:documentation-datasheet:start

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
how-tos:documentation-datasheet:start [2019/12/11 11:47]
Dennis Stampfer
how-tos:documentation-datasheet:start [2019/12/12 17:43] (current)
Dennis Stampfer
Line 66: Line 66:
  
 The documentation of the **DomainModel** and **System** projects works analogously to the here presented **Component** documentation,​ with the only difference of the Datasheet file extensions which are analogously **.domainModelsDatasheet** and **.systemDatasheet**. The documentation of the **DomainModel** and **System** projects works analogously to the here presented **Component** documentation,​ with the only difference of the Datasheet file extensions which are analogously **.domainModelsDatasheet** and **.systemDatasheet**.
 +
 +
 +===== Free Form Documentation =====
 +
 +To describe and document the algorithm that you implemented in a component, component behavior, or anything that is not covered by the above means for documentation,​ proceed as follows:
 +
 +  * Create a folder "​documentation"​ in your project root
 +  * Place at least a index.md in that folder and put your documentation in markdown into that file
 +  * Feel free to add any figures and further .md files to the documentation/​ folder. Make sure to link to them via index.md
  
 ===== Acknowledgements ===== ===== Acknowledgements =====
how-tos/documentation-datasheet/start.txt · Last modified: 2019/12/12 17:43 by Dennis Stampfer