From b9d5370753626c57a936c9de2a04f3c6c275aa30 Mon Sep 17 00:00:00 2001 From: Jannes Siebler Date: Mon, 23 Jan 2023 12:59:01 +0100 Subject: [PATCH] create some wiki guidelines and a glossary --- docs/auto/Glossary.md | 12 ++++++++++++ docs/auto/Wiki_Guidelines.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 docs/auto/Glossary.md create mode 100644 docs/auto/Wiki_Guidelines.md diff --git a/docs/auto/Glossary.md b/docs/auto/Glossary.md new file mode 100644 index 00000000..42c173cc --- /dev/null +++ b/docs/auto/Glossary.md @@ -0,0 +1,12 @@ +--- +title: DeFiChain Glossary +description: The official DeFiChain gloassry. The most common used words of the DeFiChain ecosystem and a small description. +--- + +DeFiChain App - Is the short form of the DeFiChain Wallet desktop app, which can be downloaded for macOS, windows and linux + +DeFiChain DEX - The native decentralized exchange of the DeFiChain ecosystem + +DeFiChain mobile app - Is the correct word for the lightweight, mobile app, which can be downloaded for iOS and Android + +TODO - Finish glossary \ No newline at end of file diff --git a/docs/auto/Wiki_Guidelines.md b/docs/auto/Wiki_Guidelines.md new file mode 100644 index 00000000..a20d0195 --- /dev/null +++ b/docs/auto/Wiki_Guidelines.md @@ -0,0 +1,28 @@ +--- +title: DeFiChain Wiki Guidelines +description: The official guidelines for a new article. Uniform writing style and glossary. +--- + +DeFiChain Wiki functions similar to Wikipedia (wikipedia.com) in a sense that everybody [can write an article](./Contribute.md) to best explain a certain topic of the DeFiChain ecosystem and to ultimately help others understand. A wiki should be always 'neutral' and use a similar writing style across all articles. To avoid confusion in a complex ecosystem, it is also very important to use always the same words for the same things. For that please refer to the [DeFiChain Glossary](./Glossary.md). + +## Always write in 3rd person {#defichain-wiki-guidelines-point-of-view} + +A DeFiChain Wiki article should always be written in 3rd person, as this is the most universal form of writing and naturally enforces a more precise writing style. Also the articles in this Wiki are witten by many different authors, pronouns like 'I', 'you', 'we', can mean something different for every article and reader. Here are a few examples: + +BAD: If the DeFiChain App Wallet does not work properly, you can help yourself by checking the debug.log file for error messages. +GOOD: If the DeFiChain App Wallet does not work properly, it can be helpful to check the debug.log file for error messages. + +Another example could be: + +BAD: Here I describe a solution that works from time to time when the DeFi wallet does not start correctly. Sometimes even this approach does not work. First, please make sure you have a secure backup. +Good: This article describes a solution that works from time to time when the DeFi wallet does not start correctly. Sometimes even this approach does not work. A person should always have a secure backup, before trying this solution. + +## Always use the words specified in the glossary {#defichain-wiki-guidelines-glossary} + +DeFiChain App - Is the short form of the DeFiChain Wallet desktop app, which can be downloaded for macOS, windows and linux + +DeFiChain DEX - The native decentralized exchange of the DeFiChain ecosystem + +DeFiChain mobile app - Is the correct word for the lightweight, mobile app, which can be downloaded for iOS and Android + +Full glossary can be found [here](./Glossary.md)