---
# System prepended metadata

title: 'TBD Developer Docs, Doc Writing Process'

---

# TBD Developer Docs, Doc Writing Process

Status: Draft
DRI: Bobbilee, Kirah (reviewer/collab)

## Timeline

### How do you want to tell us
1. DONE: post in slack channel
2. Coming in 2 weeks (ideal): post in slack channel

## Answers we'll need:
1. Link to a notion, asana taks, or a github commit (or PR, or repo), slack thread
2. What is it for, do, etc. and what API/SDK etc was it for (we'll be able to tell in the link above)
3. DRI
4. Approx release date if not out yet

## When do I need to set up time to chat with DevRel
If it's a huge change, repo, or new component, changes to endpoints / breaking changes...anything that should have a guide, tutorial, sample app, sandbox etc


## If a brand new repo or large update
1. Prep a release note
2. Add to release notes index
3. Update or make new pages in docs
4. We'll tag DRI for review in a PR: PR for release note, PR for doc changes (if there are any)
5. We'll then publish it to docs
6. Prep tutorial, new guide, update any quickstarts or intro pages with new content
7. Prep Discord discussion and twitter (Ebony can think of more community ideas / engangement)
8. Video (optional)
9. Blog (optional)

## If small change like doc change, etc 
1. Prep a release note
2. Add to release notes index
3. Update docs if needed
4. Prep a PR for DRI to review
5. Publish


| Content Type | Contact DRI | Information Needed |
| -------- | -------- | -------- |
| Text     | Text     | Text     |


## Process
### Introducing new projects
* [Templates](https://github.com/TBD54566975/docs-sitemap/tree/templates/Templates) provided to OSE
* DevRel to provide a questionnaire for knowledge transfer, which OSE Engineer will complete for every new project
* If more information is needed, DevRel will schedule a 30-minute knowledge transfer session with OSE Engineer
* DevRel will create and publish the content

### Making changes to existing projects
* OSE Engineer opens a [PR](https://github.com/TBD54566975/developer.tbd.website) and requests DevRel's review

---
Meeting Notes:
- DEADLINE, roadmap needs to be clear product / or feature is coming out, we need like 2 weeks before copy needs to be to the dev rel team, and any sample apps that needs to be made or tutprials we'll need meetings scheduled 3 weeks before so time for building content...
- TEMPLATE NEEDED: Either i or developer Look over the templates: and let us know what template needs to be filled out - is it a new endpoint or project
*- Common problems (does the guide need a troubleshooting note or refernece)*
- Small Change
    - Just go in and make a PR
- New feature, page, sample app etc?
    - Fill out DevRel form that we'll make

- Set meeting(s) to teach dev rel:
    - Intro page copy
    - Quickstart copy page
    - Any embedded other pages with features / concepts
    - Sample Apps will need to be made?

