Author style guide: Difference between revisions

From DAO Governance Wiki
Jump to navigation Jump to search
m (Craig Calcaterra moved page DGF Wiki Author Style Guide to Author Style Guide)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
This DGF wiki style guide describes the overarching theme of the [[Main Page|DGF Wiki]].
In short, follow the currently accepted DGF [[wiki page template]].
At length, follow the approach that underlies the DAO Governance Framework design.
== Design Considerations ==
== Design Considerations ==
Wiki self-similar design leads to better
Wiki self-similar design leads to


# Understanding/navigation/learning
# better understanding & more efficient navigation and learning
# Quicker Wiki development
# quicker wiki development
# More convergent vision of the document, so it helps resolve debates.
# more convergent vision of the document, helping to resolve debates.


Goal is to build an accurate, useful, and attractive document.   
The goal is to build an accurate, useful, and attractive document.   


--We following most of the conventions on Wikipedia. For example, each time a term is used for the first time on a page, it is linked to the page/section that defines it. The second and later time it is used, there is no link. We follow Wikipedia’s style guide for three reasons. First, out of respect for the best decentralized organization ever created. Second, because people have already trained themselves how to navigate the pages. Third, if we have an improvement, we should first try to convince Wikipedia to change.
We will try to follow many conventions of Wikipedia. For example,  
 
* Each time a term is used for the first time on a page, it is linked to the page/section that defines it. The second and later time that term is used, do not link.
* Lengths of pages should be constrained above and below. A page that is too complicated should be summarized and split into multiple pages. A page that is too short is a [[wikipedia:Wikipedia:Stub|stub]] and should be elaborated or deleted and reincorporated in the root page.
 
We try to follow Wikipedia’s style guide for three reasons. First, out of respect for the most effective decentralized organization ever created. Second, people are already trained to navigate Wikpedia's page style, so it will lead to greater learning efficiency. Third, if we have an improvement, we should first try to convince Wikipedia to change.


== Page Structure ==
== Page Structure ==
This is the archetypical design for organizing the content in each page on the DGF Wiki.
The archetypical design structure for organizing content in a page:
 
'''Top:'''
 
* Short intro
* Contents = Links to sections in current page Overview
 
'''Body'''
 
Split into 3 sections, based on the information theory triad:


1. Overview/ judgements/ perceptions/ information storage


Top: Outline
Current conclusions on the subject. This comes first, because the wiki is the information storage part of the project.


Links to sections
[Followed by  Contents Links]   


2. Theory/ legislation/ thought/ information processing/ answers why the subject of the page is important


Bottom: links to
History


# Mathematical formulas relevant to this page
Why is it right?
# code related to this page
# outside references
# page references


Future


Bottom Bottom: smaller font grey
3. Execution/ action/ information transmission


Members; Contributors’ Guide (links to: [Transcendental Values; this Page Style Guide; conflict resolution protocols [taken from Wikipedia to start]; … ]
Applications 


Each of these subjects can be further broken down into subsections along the same lines. If necessary, within the page, but preferably in a linked page for that subject.


Body
'''Bottom:'''


Split into 3sections:
links to


1. Overview/current conclusions on the subject.
# Detailed design of this subject
# Applications
# Mathematical formulas related to this subject
# Code related to this subject
# Downloads available for this subject
# See also [internal links]
# Notes [footnotes for this page]
# Citations [auto-generated footnotes with shorthand for the full references below]
# References


Info storage, current judgements, perceptions
'''Bottom Bottom:''' smaller font, grey


<small>Members; Contributors’ Guide; general announcements...</small>
== Typography ==
When defining a term, use italics. For example: "The ''minting ratio'' determines the proportional number of REP minted to the fee."


2. Why?/theory/legislation/thought/info processing
== Reference style ==
=== Articles ===
Author1 First Name Second Name & Author2 & ... (Date published) "Title", Publisher.


How we got here. Why it's right. Where we're going.
Available at: <nowiki>http://website</nowiki> (Retrieved date: year month day)




3. Execution/transmission/action
Example:


Applications
Craig Calcaterra & Wulf Kaal & Vlad Andrei (2018 February 18) "Blockchain Infrastructure for Measuring Domain Specific Reputation in Autonomous Decentralized and Anonymous Systems", University of St. Thomas (Minnesota) Legal Studies Research Paper No. 18-11. Available at SSRN: <nowiki>https://ssrn.com/abstract=3125822</nowiki> or <nowiki>http://dx.doi.org/10.2139/ssrn.3125822</nowiki> (Retrieved 2023 April 11)


=== Books ===
Author1 First Name Second Name & Author2 & ... (Date published) ''Title'', Publisher.


Available at: <nowiki>http://website</nowiki> (Retrieved date: year month day)


Each of these subjects can be further broken down into subsections along the same lines. If necessary, within the page, but preferably in a link.
Example:


Craig Calcaterra & Wulf Kaal (2021) ''Decentralization'', De Gruyter, pp. 57-59.


= See Also =
== See Also ==
* [[Code formatting examples|Code Formatting]]
* [[Contributors guide]]
* [[Ethical Considerations|Ethical considerations]]
* [[Governance Philosophy|Governance philosophy]]
* [[Guiding Principles|Guiding principles]]
**[[Guiding principles#Individual code of conduct guidelines|Individual code of conduct]]
**[[Guiding Principles#Group governance code of conduct|Group governance code of conduct]]
*[[Transcendental values|Transcendental Values]]

Latest revision as of 18:44, 3 July 2023

This DGF wiki style guide describes the overarching theme of the DGF Wiki.

In short, follow the currently accepted DGF wiki page template.

At length, follow the approach that underlies the DAO Governance Framework design.

Design Considerations[edit | edit source]

Wiki self-similar design leads to

  1. better understanding & more efficient navigation and learning
  2. quicker wiki development
  3. more convergent vision of the document, helping to resolve debates.

The goal is to build an accurate, useful, and attractive document. 

We will try to follow many conventions of Wikipedia. For example,

  • Each time a term is used for the first time on a page, it is linked to the page/section that defines it. The second and later time that term is used, do not link.
  • Lengths of pages should be constrained above and below. A page that is too complicated should be summarized and split into multiple pages. A page that is too short is a stub and should be elaborated or deleted and reincorporated in the root page.

We try to follow Wikipedia’s style guide for three reasons. First, out of respect for the most effective decentralized organization ever created. Second, people are already trained to navigate Wikpedia's page style, so it will lead to greater learning efficiency. Third, if we have an improvement, we should first try to convince Wikipedia to change.

Page Structure[edit | edit source]

The archetypical design structure for organizing content in a page:

Top:

  • Short intro
  • Contents = Links to sections in current page Overview

Body

Split into 3 sections, based on the information theory triad:

1. Overview/ judgements/ perceptions/ information storage

Current conclusions on the subject. This comes first, because the wiki is the information storage part of the project.

[Followed by Contents Links]

2. Theory/ legislation/ thought/ information processing/ answers why the subject of the page is important

History

Why is it right?

Future

3. Execution/ action/ information transmission

Applications

Each of these subjects can be further broken down into subsections along the same lines. If necessary, within the page, but preferably in a linked page for that subject.

Bottom:

links to

  1. Detailed design of this subject
  2. Applications
  3. Mathematical formulas related to this subject
  4. Code related to this subject
  5. Downloads available for this subject
  6. See also [internal links]
  7. Notes [footnotes for this page]
  8. Citations [auto-generated footnotes with shorthand for the full references below]
  9. References

Bottom Bottom: smaller font, grey

Members; Contributors’ Guide; general announcements...

Typography[edit | edit source]

When defining a term, use italics. For example: "The minting ratio determines the proportional number of REP minted to the fee."

Reference style[edit | edit source]

Articles[edit | edit source]

Author1 First Name Second Name & Author2 & ... (Date published) "Title", Publisher.

Available at: http://website (Retrieved date: year month day)


Example:

Craig Calcaterra & Wulf Kaal & Vlad Andrei (2018 February 18) "Blockchain Infrastructure for Measuring Domain Specific Reputation in Autonomous Decentralized and Anonymous Systems", University of St. Thomas (Minnesota) Legal Studies Research Paper No. 18-11. Available at SSRN: https://ssrn.com/abstract=3125822 or http://dx.doi.org/10.2139/ssrn.3125822 (Retrieved 2023 April 11)

Books[edit | edit source]

Author1 First Name Second Name & Author2 & ... (Date published) Title, Publisher.

Available at: http://website (Retrieved date: year month day)

Example:

Craig Calcaterra & Wulf Kaal (2021) Decentralization, De Gruyter, pp. 57-59.

See Also[edit | edit source]

Retrieved from "https://daogovernanceframework.com/w/index.php?title=Author_style_guide&oldid=1234"