Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Software Documentation #132

Open
JaroCamphuijsen opened this issue Sep 9, 2024 · 1 comment
Open

Software Documentation #132

JaroCamphuijsen opened this issue Sep 9, 2024 · 1 comment
Labels
module discussion General module discussion, one issue per existing module

Comments

@JaroCamphuijsen
Copy link
Collaborator

No description provided.

@JaroCamphuijsen JaroCamphuijsen added the module discussion General module discussion, one issue per existing module label Sep 9, 2024
@JaroCamphuijsen
Copy link
Collaborator Author

In the software documentation module, various "types" of documentation are presented in various places. However sometimes these types relate to 1) the purpose or audience of the software (user, developer, deployment), sometimes the type refers to 2) how it is implemented/distributed (README file, website, wiki, comments/docstrings in the code, technical paper or written book could also be added) and sometimes the type means how the documentation is presented/written down (e.g. tutorial, how to, API docs, list of available elements, narration/story). I would like to make a better distinction between these three "types of types" and integrate that in the slides and exercises.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
module discussion General module discussion, one issue per existing module
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JaroCamphuijsen