Author style guide: Difference between revisions
m (→See Also) |
m (Text replacement - "Code Formatting Examples" to "Code formatting examples") |
||
| Line 70: | Line 70: | ||
= See Also = | = See Also = | ||
* [[Code | * [[Code formatting examples|Code Formatting]] | ||
* [[Contributors Guide]] | * [[Contributors Guide]] | ||
* [[Ethical Considerations|Ethical considerations]] | * [[Ethical Considerations|Ethical considerations]] | ||
Revision as of 18:48, 5 April 2023
The DGF Style Guide describes the overarching theme of the DGF Wiki.
Design Considerations
Wiki self-similar design leads to better
- Understanding/navigation/learning
- Quicker Wiki development
- More convergent vision of the document, so it helps resolve debates.
The goal is to build an accurate, useful, and attractive document.
We will try to follow most of the 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 it is used, there is no 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. Otherwise it should be deleted and reincorporated in the root page.
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, 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
This is the archetypical design for organizing the content in each page on the DGF Wiki.
Top:
Overview
Contents = Links to sections in current page
Bottom:
links to
- Mathematical formulas related to this Subject
- Code Related to this Subject
- See also [internal links]
- Notes [footnotes for this page]
- Citations [auto generated footnotes with shorthand for the full references below]
- References
- External links
Bottom Bottom: smaller font grey
Members; Contributors’ Guide; general announcements...
Body
Split into 3 sections, based on information theory triad:
1. Overview/judgements/perceptions/ info storage
Current conclusions on the subject
[Followed by Contents Links] 2. Why?/theory/legislation/thought/ info processing
History
Why it's right
Future
3. Execution/action/ info 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.