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

Who are the readers of the docs? #3

Closed
abitmore opened this issue Apr 14, 2018 · 5 comments
Closed

Who are the readers of the docs? #3

abitmore opened this issue Apr 14, 2018 · 5 comments

Comments

@abitmore
Copy link
Contributor

It's not clear to me who will be reading the docs. AKA we need a good UX-design, so people can get started quickly, and get needed info easily.

Here are some wild thoughts.

Is this an overall doc site, or only for developers?

It's best to have a system overview, like those in https://www.google.com/search?q=system+overview&tbm=isch.

  • system components (the outside, network architecture)

    • short description of each
    • how they're connected (protocol)
  • inside system: data structure, consensus

    • accounts
    • assets
    • voting
    • ...
  • people (roles) involved / services around

    • what do they do
  • How to get started (for businesses, integration guide)

    • if you're an external exchange
    • if you want to run an exchange on top of BitShares
    • if you're a merchant, or want to build tools for merchants, to accept bitUSD or etc
    • if want to build data query or analysis service
    • want to build tools for trading
    • ...
  • How to get started (steps for developers)

    • if you're a backend developer
    • if you're a web developer
    • if you're a mobile app developer
    • script developer
    • ...
  • How to get started (for users)

    • download light wallet or use web wallet
    • create an account
    • transfer
    • trade
    • ...
  • for advanced users

    • issue an asset
    • botting
    • ...
@cedar-book
Copy link
Owner

About System overview. It might be needed to update but I like that the System overview BTSwolf created. I added a link on References page right now. How do you like them?
BitShares - Basic Connections Layer : infographic - basic overview - BTSwolf

@abitmore
Copy link
Contributor Author

abitmore commented May 1, 2018

The linked infographic is a good one. It shows some "people (roles) involved / services around" listed in OP. We also need other graphics.

BTW references page has changed to this.

@cedar-book
Copy link
Owner

Hi @abitmore, I have been keeping your above message on my note. But it seems I had been going somewhere. I had thought the list would be in my mind to work on but seems not. I appreciate your patients to giving me comments. But I am not doing good job to make the list.

@cedar-book
Copy link
Owner

This category: How to get started (for businesses, integration guide). I am trying to think but I do not know well about those actual Businesses. So, I cannot see or tell how they do their businesses and what they might need . So, I would like to look into the "system comportment and structures" sections.

@abitmore
Copy link
Contributor Author

abitmore commented Jun 11, 2020

Re-posted to bitshares/how.bitshares.works#35, hope that we can get more people involved. Thanks for your efforts anyway. I haven't been paying attention to this issue either, sorry for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants