---
# System prepended metadata

title: Docs Writing Process

---

# Docs Writing Process
## DevRel x OSE

### Definitions
#### Project
Any API is considered a project. Web5 JS is a project, and so is SSI Service API. 

#### Sample App
Any application that utilizes our APIs and tools. A ToDo app would be a sample app (but can also be a tutorial if instructions on how to build it accompany it.)

#### Tutorial
Any application that also explains to a developer how they can create that same application locally, and helps illustrate how to consume our APIs. A ToDo app would be a sample app and tutorial. 

#### Concept
Any concept that goes into a guide, and that our APIs enable representing inside of an application. Decentralized IDs are a concept, and how to CRUD a DID is a Guide.

### On-ramp
#### Goals
- Find out what part of the Docs site needs to be updated relative to the OSE change that is being delivered
- Have a clear path forward for creating the content
- Have a PR(s) ready for review
#### Approach
-  Fill out a form to deliver to DevRel that includes:
    -  Link to the OSE change / repo
    -  Choose 1:
        -  New project?
            -  Explore the Docs site and find an appropriate location for the proposed content
            -  Review the templates folder and locate the appropriate template. Template candidates may be one or more of:
                -  Guide
                -  Tutorial
                -  Intro
                -  QuickStart
            -  For example: A brand new project may need all four of these, while a new concept under the Web5 JS umbrella may need only a Guide. 
        -  Existing project?
            -  Explore the Docs site and find the affected content
            -  Open a PR to make the update
                -  PR should include:
                    -  Description of the change
                    -  Why the change was needed
                    -  Why it affects that area of the Docs site
                -  DevRel should take the PR and recall any other areas of the Docs Site that may be affected. DevRel will open an additional PR(s) for review by originating OSE PR opener 



### Off-ramp
#### Goals
- Have the updated content or new doc in production
- If big enough, announce change to community

#### Approach
- DevRel will then start working on prepping an announcement:
    - Discord
    - Release Note?
    - Twitter

- If it's a big enough concept/project change or addition DevRel will:
    - Prep written tutorial
    - PR tag for review the original PR opened (eng or PM from OSE etc)
    - Publish written tutorial
    - DevRel will start working on a video script
    - Notion or public doc to review the video script
    - Record the video
    - Share recording for review
    - Publish video
    - Announcements:
        - Twitter
        - Discord
        - etc? Newsletter if we do one eventually


