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

Accreditation of responses #4

Open
snowkidind opened this Issue Oct 16, 2018 · 6 comments

Comments

4 participants
@snowkidind
Copy link
Contributor

snowkidind commented Oct 16, 2018

Considering the text located at:

https://kb.omgcommunity.org/omisego-official-guide-1/why-did-a-for-profit-company-choose-to-invest-in-building-a-public-network

I am left with a couple questions:

  1. Who said this?
  2. Is the knowledge base comprised of all "official" answers or tweaked versions of official answers?

The answers to these are ambiguous to me. And that is the issue. I feel there should be a source cited on every answer. Example, if Jun answered this question in an AMA there should contain a link to the AMA and the quote should be word for word, in quotes. If the source was a redditor who was not affiliated with omise then it should be cited as such and considered an opinion or an unofficial assumption.

Work should be done to dilligently trace the sources of the existing answers, and this information should be a submission requirement for further additions to the knowledge base.

Wikipedia handles this issue with three sections on each page: References, Further Reading, and External Links.

The end result would be a much more citable set of documentation which also links to the source of the data in each answer.

@jet86

This comment has been minimized.

Copy link
Contributor

jet86 commented Oct 16, 2018

This particular question and answer comes directly from the Official Guide https://cdn.omise.co/omg/officialguide.pdf

This raises an excellent point though about tracking the sources of information compiled here.

@Ro5s

This comment has been minimized.

Copy link
Contributor

Ro5s commented Oct 29, 2018

Agree with need to include citations. Folks might assume this is a low-quality kb otherwise. Though, I think a level of tweaking and paraphrasing is helpful for patchwork topics like PoA, with multiple sources saying similar things. I guess we can ask, more generally: is the KB a simple explainer of OMG topics (community parsing together), or more an infodump of official sources organized by OMG topics for folks to parse themselves? In any event, I will try and include links to anything I add here.

@snowkidind

This comment has been minimized.

Copy link
Contributor Author

snowkidind commented Oct 29, 2018

I wonder if there would be some way of organizing a hierarchy to filter the information into some basic categories in order for the reader to understand what they are looking at. I found this "DIKW Pyramid" Hierarchy to be of interest, maybe we can structure it similarly...

https://en.wikipedia.org/wiki/DIKW_pyramid

Perhaps a structure as such for each topic:

Wisdom - Overall takeaways that represent what we know at the time.
Knowledge - Facts that support the takeaways.
Information - Who said What, Citations.
Data - Links and references to resources which validate.

Additionally, it would be cool if each section could be pulled in via an api in order to allow external applications to format it.

@Ro5s

This comment has been minimized.

Copy link
Contributor

Ro5s commented Oct 29, 2018

I like that. E.g., from that filter (very rough draft):

Wisdom - Tesuji milestone is close to completion.
Knowledge - (i) PoA on internal testnet, (ii) contract audits in final stages, [etc.]
Information - (i) OmiseGO: "PoA is what’s currently on internal testnet" (OmiseGO AMA #2 - October 22, 2018); (ii) OmiseGO: "mostly-done Quantstamp audits" (OmiseGO AMA #2 - October 22, 2018)
Data - (i) https://www.reddit.com/r/omise_go/comments/9qemoy/omisego_ama_2_october_22_2018/, (ii) https://www.reddit.com/r/omise_go/comments/9qemoy/omisego_ama_2_october_22_2018/.

@jet86

This comment has been minimized.

Copy link
Contributor

jet86 commented Oct 29, 2018

I like that idea conceptually, but I do wonder if it will overcomplicate things (the answer may be "no" - I'm just wondering). It will be important to make it as easy as possible to add new answers to the kb and to ensure everything remains accurate and up to date.

@nebali nebali added the bounty label Nov 1, 2018

@nebali nebali added this to To do in Knowledge Base Nov 2, 2018

@snowkidind

This comment has been minimized.

Copy link
Contributor Author

snowkidind commented Nov 24, 2018

Proposal for a standardized format for applying metadata markdown files containing knowledge base data.

Structure.docx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment