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

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

Open
elwinschmitz opened this issue Nov 20, 2023 · 2 comments
Open
Labels
Client: Demo Specifically for Demo-purposes documentation Improvements or additions to documentation instances About deployments, configuration of instances etc.

Comments

@elwinschmitz
Copy link
Member

elwinschmitz commented Nov 20, 2023

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 elwinschmitz added documentation Improvements or additions to documentation Client: Demo Specifically for Demo-purposes instances About deployments, configuration of instances etc. labels Nov 20, 2023
@elwinschmitz
Copy link
Member Author

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
Copy link
Member Author

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

  • update texts + screenshots there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client: Demo Specifically for Demo-purposes documentation Improvements or additions to documentation instances About deployments, configuration of instances etc.
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant