---
tags: docs, guides
---

# 📋 How to Help With Docs

**Rule #1**: Have an idea to make something better? Don't ask, just do it. *Version tracking exists.* 🤯

<br />
## DASHBOARD

Docs: https://docs.yearn.finance/

### Document tracking and Project Management is on [Trello](https://trello.com/invite/b/J9mwzkLf/0a9bb512d6c5ed8d6a61f3f15637df1d/iearn-documents)

<br />

## COLLABORATIVE WORKFLOW
*Anyone can execute any of these steps at any time unless otherwise noted. This is not a top-down process*
### New Doc Creation
1. Idea for a new doc solidifies
2. Create a **hackmd page** for it¹
3. Add edit link to the **in-progress list** above
4. Share link on **#documentation** to gather forces
5. We write the doc and add diagrams
6. When ready to be published, anyone [pushes](https://hackmd.io/c/tutorials/%2Fs%2Flink-with-github#Push-to-GitHub) to the [staging github](https://github.com/tracheopteryx/docs)
7. We check our [staging gitbook](https://app.gitbook.com/@tracheopteryx/s/docs-yearn-finance/) for any issues and revise if needed
8. @tracheopteryx reviews and if all good submits a pull request to the [live github repo](https://github.com/iearn-finance/docs)
9. An admin merges the pull request and the page becomes a live subdomain of [docs.yearn.finance](http://docs.yearn.finance)

[1] *If you prefer to write in a different editor like google docs, you are welcome to -- but it will have to eventually get formatted correctly in github (or hackmd -> github as described here).*

### Doc Development Process
Sometimes the thing will just getting written. But more complicated topics or collaborative efforts may require a phased approach. Here is an example of how that may go. These steps need not be so linear or sequential:
1. An **engineer** writes the technical outline
2. A **technical writer** fleshes that out ELI5 style so it's super clear to an average reader
3. A **copywriter** makes it more fun to read and in the brand voice
4. An **editor** cuts and suggests changes while fixing language, grammar, spelling, and style issues
5. A **designer** crafts diagrams to visually communicate key concepts
6. Final touches
7. Publish
8. Update and improve regularly over time as things change

### Keeping Docs Up-To-Date
If you notice a way to improve a doc, discuss in the discord and **make the change youself** in the hackmd page, push it, and make sure to **tell us** in the discord. We can do pushes as much as we want, but will do pull requests less frequently.

<br />

## RESOURCES

- HackMD Docs: https://hackmd.io/c/tutorials
- Gitbook Docs: https://docs.gitbook.com/
- Staging github repo: https://github.com/tracheopteryx/docs
- Staging gitbook: https://app.gitbook.com/@tracheopteryx/s/docs-yearn-finance/
- Live github repo: https://github.com/iearn-finance/docs
- Live published gitbook: http://docs.yearn.finance