Author Topic: [Worker] Revision of Whitepapers and Improvements of Technical Documentation  (Read 807 times)

0 Members and 1 Guest are viewing this topic.

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12551
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
Worker proposal

Given the growth of the BitShares ecosystem, we, Blockchain Projects BV see the urgent need to revise the existing
white papers and documentation of the whole BitShares platform.

From our recent business developments, we can confirm that regulators are taking a closer look into the whole
crypto ecosystem and they are constantly confused due to unaligned use of terminology of old economy, such
as assets, shareholders, equity, dividends.

Unfortunately, our technical information is also “polluted” with analysis in non-technical areas, such as bitassets
and trading. As can be found in the second spokesperson report, this requires an major rework.

Furthermore, the existing documentation hasn’t been updated and reviewed consistently. The majority of newcomers
to the platform run into similar issues which could be resolved by improved documentation and better integration into
the whole ecosystem (e.g. the reference wallet).

To ensure a proper and accurate representation of the BitShares platform, major rework of existing material is required.
The documentation will not be reviewed by legal council as it has a purely technical aim.

Please note that this worker proposals focuses strongly on the technical aspects of BitShares. Legal aspects need to
be dealt with separately.

It is our strong believe that it is required to separated the technical documentation (such as RPC, blockchain APIs, etc.)
from the functional and legal description (such as the DEX, and bitassets). This will help to distinguish BitShares (as
a platform) from the BTS token (as a cryptocurrency) and the services (such as the exchange) offered through smart
contracts.

Read more
http://www.bitshares.foundation/worker/budget/2018-02-documentation
Give BitShares a try! Use the http://testnet.bitshares.eu provided by http://bitshares.eu powered by ChainSquad GmbH

Offline fav

  • Administrator
  • Hero Member
  • *****
  • Posts: 4202
  • No Pain, No Gain
    • View Profile
  • BitShares: fav
voted.
► How-to Buy BitShares: https://goo.gl/i9j2YZ

Offline paliboy

The proposal says that total amount is $80,000 but later in the text it mentions that it's capped at $150,000.
Where are you going to find a content writer with extensive knowledge of BitShares? Are you relying on community?

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12551
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
The proposal says that total amount is $80,000 but later in the text it mentions that it's capped at $150,000.
Where are you going to find a content writer with extensive knowledge of BitShares? Are you relying on community?
Thanks for the report, the $150k was an error that was fixed.

There are actually knowledgable writers already working on a renewed documentation page, all it needs is funding to have this go forward ..
Give BitShares a try! Use the http://testnet.bitshares.eu provided by http://bitshares.eu powered by ChainSquad GmbH

Offline Customminer

  • Sr. Member
  • ****
  • Posts: 454
  • Bitshares FTW!
    • View Profile
    • Gridcoin.US
  • GitHub: grctest
Will this work alongside current documentation uplift efforts? https://t.me/joinchat/AWRo40N1sGr9SNGo_pv3KA

Or could there be overlap in work being done?
Hertz, Beyond Bitshares, Gridcoin!

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12551
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
Will this work alongside current documentation uplift efforts? https://t.me/joinchat/AWRo40N1sGr9SNGo_pv3KA
The idea is to utilize the available resources there and merely guide the documentation efforts
to fit into the lessons learned (most compliance) ... We'd also like to find a solution to have a
community member deal with the project management and have everyone benefit from their
work. Consider the whole worker proposal a "bounty program" that is lead by Blockchain Projects BV
(as a legal entity to take the lead and responsibility) and put forth by the community under guidance.
Give BitShares a try! Use the http://testnet.bitshares.eu provided by http://bitshares.eu powered by ChainSquad GmbH

Offline Chris4210

  • Global Moderator
  • Sr. Member
  • *****
  • Posts: 414
  • Running for BitShares Committee Member
    • View Profile
    • www.payger.com
  • BitShares: chris4210
voted. I am looking forward to the updated and improved documentation. Please separate marketing and technical speech in the new documentation. They do not belong together. I was sitting with my team for weeks to pull these two things apart in the current documentation.
Vote Chris4210 for Committee Member http://bit.ly/1WKC03B! | www.Payger.com - Payments + Messenger | www.BitShareshub.io - Community based fanpage for the BitShares Blockchain

Offline blockchained

 +5%

Offline abit

  • Committee member
  • Hero Member
  • *
  • Posts: 3137
    • View Profile
    • Steemit Blog
  • BitShares: abit
  • GitHub: abitmore
Firstly please get this site updated: https://bitshares.org/doxygen/classgraphene_1_1app_1_1database__api.html

Best automatically update it every time when there is a new release.

Last update was: Generated on Wed Jan 13 2016 11:43:49 for Graphene by   doxygen 1.8.10

Update: done. Generated on Sun Feb 4 2018 17:03:24 for Graphene by   doxygen 1.8.11

https://bitshares.org/doxygen/hierarchy.html

This is a good doc for reference.
« Last Edit: February 04, 2018, 05:20:32 pm by abit »
BTS account: abit
BTS committee member: abit
BTS witness: in.abit

Offline Brekyrself

  • Sr. Member
  • ****
  • Posts: 496
    • View Profile
This got voted in as well, BitShares is on a roll for getting things done!  I've never seen this many active workers!

Offline pnomolos

Voted.

From the UI documentation side of things, it's difficult to keep them up-to-date due to the fact that the client is still under very active development and things are changing regularly.  An idea that popped into my head would be the ability to be able to "tag" elements within the client with UI hints that could be then used by a selenium-driven tool for automatically generating new screenshots with the appropriate outlines/highlights.  Obviously this would not be able to cover all the cases, but perhaps it may be worth the time -- or someone has already written enough of a tool that we'd be able to piggyback off of?

As is the case with most open source projects, documentation tends to be the most neglected.  While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.

Offline clockwork

  • Committee member
  • Full Member
  • *
  • Posts: 96
    • View Profile
  • BitShares: clockwork
While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.

Sounds like exactly one of the people Fox is looking to hire for the core team. Check the new core team proposal and get in touch with Ryan if you haven't already.

Offline xeroc

  • Board Moderator
  • Hero Member
  • *****
  • Posts: 12551
  • ChainSquad GmbH
    • View Profile
    • ChainSquad GmbH
  • BitShares: xeroc
  • GitHub: xeroc
While I'm more than willing to help with writing technical/UI documentation, I'd also love to get involved with some tooling to help automate what can be automated so more time can be focused on improving that which can not be automated.
This sound great! All the help is very much appreciated.
Do you prefer backend (c++) development, prefer frontend (js/react) stuff or would rather want to help on the library (python, js, java) side of things?
There is work left on all of those fronts :D
Give BitShares a try! Use the http://testnet.bitshares.eu provided by http://bitshares.eu powered by ChainSquad GmbH

Offline pnomolos

It'd be great helping on either the frontend or library documentation.  I'd be willing to help on the backend documentation as well, but c++ is definitely not my area of expertise - if my help is most urgently needed there then I'd probably be much more useful writing higher level guides and tutorials as opposed to anything significantly technical.

I've joined the Telegram group so if it'd be easier to communicate directly there or via direct message that works too :)