---
title: DAOhaus Contributors Guide
tags: rangers, documentation
---

# DAOhaus Contributors Guide

## Overview
1. What is DAOhaus?
3. Why contribute to DAOhaus documentation?
5. How does DAOhaus documentation work?
7. How to contribute to DAOhaus documentation?
* Process
* Tools
* Style Guide

## 1. What is DAOhaus?

DAOhaus is a no-code platform for launching and running DAOs. It is owned and operated by the community. All DAOs on the platform utilize the glorious open-source code of [Moloch](https://www.molochdao.com/).

For more information, please refer to DAOhaus documentation: https://daohaus.club/docs/

## 2. Why contribute to DAOhaus documentation?
Since DAOs are a relatively new phenomena, there are many concepts, steps and processes that are foreign to new DAOhaus users. In order to encourage more DAO-ing in this world, we need to help more people join and summon DAOs. Your help in improving documentation is crucial here.

Furthermore, the ongoing release of new features by our Magesmiths makes it important for us to tell existing users about new features and how to use them. With clear and detailed documentation, we enable DAO users to do good with DAOhaus features to the fullest extent.

Hence, for both new and existing users, documentation is espeically crucial in user onboarding and education.

## 3. How does DAOhaus documentation work?

DAOhaus documentation is split up into 3 sections:

| Section | Persona | Content |
| ------- | ------- | ------- |
| **Users** | **General users** of app.daohaus.club | Feature-specific explainers, tutorials and FAQs |
| **Handbook** | Users who belong to a **Discord track** (e.g. Contributor, Summoner, etc. ) | Discord track-specific explainers, tutorials and FAQsw |
| **Developers** | **Developers** who want to find out more about how DAOhaus works | Developer-focused documentation |


<!--### 3.1 Current Documentation

Currently, our user documentation has 5 sections:

1. Intro
2. Basics
3. HowTo
4. UberHaus
5. FAQ

We are gradually revamping our documentation towards mid - end August 2021 for a clearer and more scalable organisation. You can find more information below.

Meanwhile, to keep things simple, all the help we need from you will be in the [FAQ section](https://daohaus.club/docs/users/proposals-faq/), unless otherwise stated.

### 3.2 End State Documentation (mid-end Aug 2021)

::: info
You can skip this section & go to section 4 for now
:::

From mid-end August 2021, this should be the documentation framework and rationale behind it.

Moving forward, the range of users interacting with DAOhaus varies in their roles, intents and DAO-savviness, so we need a clear and organised way to segment DAOhaus documentation. This should help each DAOhaus user persona find exactly what they need quickly.


First, we split the users into **dev / non-dev** as they each have very different intents and needs on how they use "DAOhaus".

For the non-devs, we then split our documentations into **(1) Docs (2) Handbook**, based on the user intent when looking for information on DAOhaus. From experience, we notice there are 2 main types of users and hence the split between Docs and Handbook (see table below)

| Persona | Looking for | Relevant Section |Sub-sections|
| ---------------------------------------------------------------------------- | --------------------------------------------- | ---------------- | --- |
| Users looking for **general information** on how different parts of DAOhaus work | General information, explainers, how it works | Documentation |**Explainer** (organised by feature set) |
| Members & summoners wanting to **achieve something but are stuck** | Actionable steps, tutorials, guides | Handbook |**HowTos & FAQs**(organised by feature set) |

Within the audience looking for "actionable information" in the Handbook section, we further split the **users into "Summoners" and "Members"** as they have different set of features important to them.
-->
With that, you have the structure of the DAOhaus documentation and where things should go. With the understanding of the documentation structure, here is how each user persona would find the information they need.

| Persona | DAOhaus User | Relevant Section | Sub-section |
| ------------------- | ------------ | ---------------- | ----------- |
| General "Scholar" | No | Documentation | General |
| New "Summoner" | Yes | Summoner Handbook | Getting Started |
| Existing "Summoner" | Yes | Summoner Handbook | HowTos/FAQ |
| General DAOMember | Yes | Member Handbook | HowTos/FAQ |

## 4. How to contribute to DAOhaus documentation?

### 4.1 Process


For you to contribute to DAOhaus docs, these are the steps:

**1. Go to [DAOhaus website's Github](https://github.com/HausDAO/daohaus-website/issues) to look for open issues**


**2. Select an issue you can work on**


>Above is an example
>
>**Issue** "Can a DAO member request loot?"
> * **Overview**:
> This issue is requested by `arentweall (Amos)` as it has been raised in the `Discord support channel`
> * **Where in the docs?**:
> `Pre-revamp FAQ section` under `Proposals` (i.e. You can click "https://github.com/HausDAO/daohaus-website/blob/prod/docs/users/proposals-faq.mdx" to access the file directly)
> * **What help is needed?**:
Based on the prompt `Yes, under your funding proposal, you can add a field "Loot Requested" to request loot`, create an `answer with screenshots` on requesting loot

**3. Fork the daohaus-website repo**

**4. Create a new branch with the naming convention "feature/issue-`ID` "**
> In the above example, the issue's ID is #24, so the branch should be issue-24

**5. Make the changes on your branch**

**6. Once you are done, commit and push the changes onto issue-`ID` branch on your own repository**

**7. Submit a PR to HausDAO's daohaus-website repository**

<!--

**4. Go to the file directory & click "Edit"**


**5. Make your changes, provide a short description & click "Commit Changes"**

 -->

**8. Reviewers / moderators will review the changes, ensuring that answers are (1) accurate (2) adhering to our [style guide](https://hackmd.io/vI1_pmTJTmy2_u0U7ZYQbA?both#43-Style-Guide) (below)**

**9. Once both criteria are passed, your changes will be approved, merged and live! 🎉**

### 4.2 Tools

| Tool | Purpose | Link |
| --------------- | ------- | ---- |
| Discord (`open-chat` under `Contributor` track) | General communications | https://discord.gg/Mrq5cUsu |
| Github (Issues) | List issues we need help with | https://github.com/HausDAO/daohaus-website/issues |
| Github (Code & PRs) |Make changes to documentation | https://github.com/HausDAO/daohaus-website |
| Hackmd |Long form announcements / note-taking / jamming| [Resource Sheet](https://ogb.stanford.edu/docs/cheatsheet/#tables) |

### 4.3 Style Guide

**4.3.1 Structure**

::: info
Currently, all changes go into respective sub-sections in FAQ. The file directory link provided in the Github issue brings you to exactly where the change is needed.
:::
When the end state documentation structure is live, please follow it here:


All of the documentation is written in Markdown, a lightweight markup language for creating formatted text using a plain-text-editor.

Here is a nice [CheatSheet](https://ogb.stanford.edu/docs/cheatsheet/#tables) for Markdown that you can use when making changes to the documentation.

We are using Github Issues to help bring contributors in, ensuring we uphold the integrity and quality of our documentation as we iterate.

**4.3.2 Grammar**

We use **US English** in our documentation

**4.3.3 Commonly troublesome words**

|Term | What it refers to? | Not how we spell it |
| ------- | ------------------------------------------ | ----------------- |
| DAO | Decentralised autonomous organisations | dao |
| DAOhaus | The DAOhaus platform, community in general | DAOHaus, DAO Haus |
| UberHaus | DAO of DAOs, governing DAOhaus | Uberhaus |
| Decentralized | Spread out, not concentrated | Decentralised |
| "" | *definition* | "" |

If there are common phrases or terms you do not understand that need to be written or contributed on, check out our [glossary](https://daohaus.club/docs/users/glossary)!

**4.3.4 Style, Voice & Tone**

1. Do not write in first person singular (me, i, etc.)
2. Use Punctuation.
3. Write positively
5. Be concise
7. Write in active voice as much as possible
8. Be clear & avoid jargon
9. When jargon is necessary, use simple language to explain.
10. Write acronyms in full when it is used first in a page
11. Provide screenshots and visual aids where possible
12. Refrain from tagging people without approval
13. Pay attention to your audience

**4.3.5 Non-text Contribution Formats**
:::info
This section is a work in progress and could use more attention
:::
* Screenshot Dimensions*

    max-height: 546.67px;
    max-width: 600px;

**if no auto-formatting*
* **Gifs** - same as screenshots.
* **Video Tutorials** - an example:

<a href="https://www.loom.com/share/4b18d118a34d479cae3930da9cecf555">
    <p>New Loom Recording - Watch Video 🎥</p>
    <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/4b18d118a34d479cae3930da9cecf555-with-play.gif">
</a>

<a href="https://www.loom.com/share/4b18d118a34d479cae3930da9cecf555">
<p>New Loom Recording - Watch Video 🎥</p>
<img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/4b18d118a34d479cae3930da9cecf555-with-play.gif">
</a>

**4.3.6 Contributor Requirements**

After you have completed your contribution, post in [`#proof-of-work`](https://discord.gg/9KfzHcU85z).

If you do not have access to the `proof-of-work` channel, visit the [`haus-roles`](https://discord.gg/89TsbY4S9g) channel and emoji the `⚒ Contributor Role` and any other role you want to take up as a community member of the Haus.

You'll now have access to the the `Contributor Track` which will guide you through the opportunities to contribute across the DAOhaus platform.

As you gain XP for creating value, you level up and before you know it you will be a Master DAOist!