User Documentation

Disclaimer: Dieser Thread wurde aus dem alten Forum importiert. Daher werden eventuell nicht alle Formatierungen richtig angezeigt. Der ursprüngliche Thread beginnt im zweiten Post dieses Threads.

User Documentation
Hey teaching team,

how should the user documentation look like for the final release?

Cheers!


The way we look at it is this: Did you make a reasonable effort to help users be able to use the software? We are not expecting anything of huge extent. How to do it depends on context. If you believe your app, for example, is sufficiently simple and then well-documented by tool tips or in-app documentation, your submitted user documentation should simply point to it.

As to user documentation format. We were really thinking just a PDF (+ DOC / ODT / LaTeX) but Ann points you may of course shoot a video or a write web page or perform an interpretative dance (with video then).