DAOhaus Docs Style Guide

1. Structure

DAOhaus documentation is split up into 3 sections:

SectionPersonaContent
UsersGeneral users of app.daohaus.clubFeature-specific explainers, tutorials and FAQs
HandbookUsers who belong to a Discord track (e.g. Contributor, Summoner, etc. )Discord track-specific explainers, tutorials and FAQsw
DevelopersDevelopers who want to find out more about how DAOhaus worksDeveloper-focused documentation

DAOhaus docs structure

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 for Markdown that you can use when making changes to the documentation.

If you like, another common tool we use in DAOhaus is https://hackmd.io/. If you prefer not to adopt the github flow, please share a hackmd with changes in #proof-of-work

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

2. Grammar

We use US English in our documentation

3. Commonly troublesome words

TermWhat it refers to?Not how we spell it
DAODecentralised autonomous organisationsdao
DAOhausThe DAOhaus platform, community in generalDAOHaus, DAO Haus
UberHausDAO of DAOs, governing DAOhausUberhaus
DecentralizedSpread out, not concentratedDecentralised
""definition""

If there are common phrases or terms you do not understand that need to be written or contributed on, check out our glossary!

4. Style, Voice & Tone

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

5. Non-text Contribution Formats

info

Work in progress

  • Screenshots
    • Dimensions:
    • Dos & Don'ts
  • Video Tutorials

6. Contributor Requirements

After you have completed your contribution, post in #proof-of-work.

If you do not have access to the proof-of-work channel, visit the haus-roles 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!