dokumentation - Githubissues

FBuervenich / scheibner_app

CMS-Simulation app for Scheibner m-tec GmbH

1 stars 0 forks source link

dokumentation #11

Closed bengschf closed 5 years ago

bengschf commented 5 years ago

anleitung (ggf als video)
class diagram (pub-paket dcdg
user tests (document + interview + doku mit bildern)
zip-archive with source code

bengschf commented 5 years ago

class diagramm:

$ flutter pub global run dcdg -o "doc/diagramm.puml"
Mit draw.io png und svg erzeugen (https://about.draw.io/use-plantuml-in-draw-io/)

bengschf commented 5 years ago

added before/after screenshots for user tests in e8fa1e9f93de6c4983a2089607575d5591c55aa9

bengschf commented 5 years ago

Felix Flinterviews

bengschf commented 5 years ago

flartdoc:

https://pub.dev/packages/dartdoc https://stackoverflow.com/questions/50304659/how-to-use-dartdoc-to-generate-the-documentation-for-flutter-like-docs-flutter-i

bengschf commented 5 years ago

$ flutter pub global activate dartdoc $ flutter pub global run dartdoc

Jeder dokumentiert seine Dateien https://dart.dev/guides/language/effective-dart/documentation

bengschf commented 5 years ago

@Buervenich @DNeuroth @bk3156s die flartdoc ist fertig und in 4a84dfb5ed0e3e7e22cc2e0a9c189bd19bb0294b gepusht. Für die Benutzeranleitung übernehme ich Kapitel 5, Benutzertests- und interviews. Ihr müsstest dann unter euch die Kapitel 1-4, Anforderungen, Funktionalität, Navgiation und Einstellungen aufteilen.