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

As a maintainer I should document the design and functionality of the overall application #3

Open
1 of 11 tasks
thescientist13 opened this issue Oct 28, 2018 · 0 comments
Open
1 of 11 tasks

As a maintainer I should document the design and functionality of the overall application #3

thescientist13 opened this issue Oct 28, 2018 · 0 comments
Assignees
@thescientist13
Labels
documentation
Milestone
Documentation

Comments

@thescientist13
Copy link
Member

thescientist13 commented Oct 28, 2018 •
edited
Loading

Type of Change

  • New Feature Request
  • Documentation
  • Improvement / Suggestion
  • Bug
  • Other (please clarify below)

Summary

To move out of a POC phase, formal features and designs should be made, to best plan out the development.

One important UX consideration I can think of will be handling long lists, so pagination strategies and / or lazy loading strategies will be required, as well as potential text searching capabilities.

Details

Topics to cover:

  1. Topology / API - How the data is managed, setup, etc
  2. Technical Architecture - server(less), API gateway, S3, etc. the infrastructure and data organization
  3. Release Management - Release process and workflows
  4. Designs: What the app should look like (this ticket)
  5. Functional Specification: What the app should do
  6. Onboarding Guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thescientist13 thescientist13

Labels
documentation
Projects
None yet
Milestone
Documentation
Development

No branches or pull requests
1 participant
@thescientist13