bitshares / bitshares/docs.bitshares.eu
Who are the readers of the docs?
- Dominant language
- No language data
- Stars
- 3
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
This is a re-post of https://github.com/cedar-book/BTS-Core-work/issues/3 which might have got lost since it's not in a bitshares repository.
---
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
* ...
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue proposes audiences and documentation areas, including system architecture, data structures, integrations, developer guides, and user workflows. Start by reviewing the proposed reader groups and deciding what the documentation should cover; done means the intended readers and information architecture are agreed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- blockchain
- Domain
- blockchain, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100