rodekruis/helpful-information

"What can HIA do for you" 1-page sales-pitch / product documentation

elwinschmitz opened this issue · 2 comments

elwinschmitz commented

To have 1 central place to "start the conversation" with.

It should contain (for example):

Usage

  • 1-sentence feature(s) explanation
  • screenshots (of Google Sheet + output)
  • Example links
  • (?) Link to a product-manual/training

Get started

  • Requirements (Google Account, etc)
  • Deployment options (pro's / cons)
  • Link to "In case of Emergency"-guide

Contact Us

  • Is there an "account manager" to point to?
  • Invite for open-source contributions?

Technical details

  • Internals (how does it really work)
    • Diagram with (external) services (also include separation of us and clients' control)
    • Point to README about the "data" flow, etc.
  • Telemetry / Monitoring
    • Explain / show current AI implementation(s) (screenshots)
    • Explain privacy considerations
  • ...
elwinschmitz commented

Possible chart:

classDiagram
class Visitor
class Editor {
    edits with Google-Account
}
class Developer {
    changes code
}

class GoogleSheets{
    Stores:
    Offers, Q&A's,
    Translated labels,
    Configuration, etc
}
class GitHub {
    hosts code
    builds web-app from code
}


class HostingService {
    hosts web-app shell (only)

    can be:
    - GitHub Pages
    - Azure Static Web Apps
    - or similar
}
class HIA {
    on public URL
}


Editor --|> GoogleSheets
Developer --|> GitHub
GitHub --|> HostingService
HostingService --|> HIA


HIA <--> Visitor
GoogleSheets <--> Visitor
Loading
elwinschmitz commented

Also, find the overlap with: https://510.global/product/hia/

  • update texts + screenshots there.