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.

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

Homework: Build Documentation #69

Open
LHMoritz opened this issue Nov 20, 2024 · 0 comments
Open

Homework: Build Documentation #69

LHMoritz opened this issue Nov 20, 2024 · 0 comments
Assignees

Comments

@LHMoritz
Copy link
Contributor

User story

  1. As a PO
  2. I want to have all the project relevant information documented
  3. So that it is easy to understand the use, architecture, design, build and deploy of the application.

Acceptance criteria

  • Criterion 1: The documentation exists as listed below. (Homworksheet)

User/design/build documentation
Create documentation on

  • how to use your software (user documentation),
  • the design of your software (architecture, code) (design documentation),
  • how to build and deploy your project (build/deploy documentation).
    If possible, use Github’s facilities for the documentation. The GitHub wiki is best, GitHub pages are fine as well, markdown files too.

If you can’t create PDFs, still create PDFs that provide links to the documentation for viewing.

@LHMoritz LHMoritz moved this to Product Backlog in amos2024ws02-feature-board Nov 20, 2024
@LHMoritz LHMoritz moved this from Awaiting Review to Feature Archive in amos2024ws02-feature-board Nov 27, 2024
@LHMoritz LHMoritz moved this from In Progress to Awaiting Review in amos2024ws02-feature-board Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Feature Archive
Development

No branches or pull requests

2 participants