---
icon: dot
label: Retype (Technical)
---

We use [Retype](https://retype.com/) ([Why Retype?](/ADR/use-retype-as-markdown-docs-tool)) for technical docs, including:

- Project-specific docs. Any kind of docs your projects need.
- Any docs that technical members of your team should read and write. You can create separate repos for these docs.

!!!light Why do we need a separate tool for technical docs?

- We need the docs inside the project so that as you write codes, you can update the docs.
- It's not easy to write codes in Confluence. [Retype supports direct inclusion of files in the docs](https://retype.com/components/code-snippet/).
- Retype supports markdown and [mermaid](https://mermaid-js.github.io/).
  !!!

[!button variant="primary" icon="info" text="How to use Retype"](https://infrastructure.pages.tapsell.ir/gitlab-ci-templates/docs-retype/)

## What Should You Include in Your Docs? A Template for Docs

=== :gear: `/docs/retype.yml` config file
You can check [this doc's config file](https://git.tapsell.ir/pegah/technical-operations/-/tree/master/docs/retype.yml) for an example
=== :loudspeaker: On-boarding page
The homepage should include steps for new members.
=== :thinking_face: Decisions (ADR)
Create a folder called `/docs/ADR` and [document your decisions](./madr.md) in it
=== :link: Links

Put all the [links to Telegram groups](../communications/manage-telegram-groups.md), Jira Project, Gitlab repo, blogs, and any other external service in the footer or header of the doc.

=== :busts_in_silhouette: Team structure
You can use [mermaid](https://retype.com/components/mermaid/) to add a simple chart of your team's structure.

```
graph TD
    A[Tech Team] -.-> V([VP of Engineering])
    A --> F[Frontend Chapter]
    A --> K[Backend Chapter]
    A --> I[Infrastructure]
```

=== :chains: Operations and Processes
You can document processes in `/docs/processes`. Examples:

- Code review sessions
- Workflow

===
