Skip to content

Commit

Permalink
Revisions to #1376 (#1392)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bunny authored Aug 17, 2020
1 parent 5244fbf commit 8ee0f4d
Showing 1 changed file with 32 additions and 36 deletions.
68 changes: 32 additions & 36 deletions handbook/product/roles/technical_writer.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,42 @@
# Technical Writer

We are looking for a Technical Writer to plan, create, revise, and maintain developer documents and educational content as an integral part of the product team (Product Management, Product Design, Technical Documentation), working closely with the engineering, design, and marketing teams. The content is often in the form of developer docs but may also include sample code, tutorials, or other supplemental materials. Regardless of what you are writing, creating, or designing, a technical writer’s primary job is to explain complex information in an easy-to-understand manner. In this role, you will be tasked with writing world-class developer-facing documentation.
We are looking for a Technical Writer to plan, create, revise, and maintain developer documents and educational content as an integral part of the [product team](https://about.sourcegraph.com/handbook/product), working closely with the engineering, design, and marketing teams. The content is often in the form of developer docs but may also include sample code, tutorials, or other supplemental materials. Regardless of what you are writing, creating, or designing, a technical writer’s primary job is to explain complex information in an easy-to-understand manner. In this role, you will be tasked with writing world-class developer-facing documentation.

## Responsibilities

- Plan, research, write, revise, and maintain technical documentation for internal or external engineering audiences.
- Edit, clarify and proofread documents written by others, and coach non-writers on ways to improve their writing skills.
- Own docs.sourcegraph.com
- Make Sourcegraph documentation top tier
- Quality of existing documentation
- It is clear and easy to read
- It is correct
- It is organized
- There are great examples
- Support creation of videos
- Surface needed topics
- Write scripts for the videos
- Support developers writing documentation and technical blog posts
- Depending on what they want:
- Interview a developer and writing for them
- Edit copy written by the developer
- Edit, clarify, and proofread documents written by others, and coach non-writers on ways to improve their writing skills.
- Own docs.sourcegraph.com:
- Make Sourcegraph documentation top-tier
- Own the backlog of issues with the documentation
- Is a resource for other teams on copy
- Marketing material such as:
- Social media posts
- Marketing blogs
- Release blog post(s)
- Marketing site copy
- Design and engineering copy review
- Assess quality of existing documentation:
- It is clear and easy to read?
- It is correct?
- It is organized?
- Are there great examples?
- Support creation of videos
- Surface needed topics
- Write scripts for the videos
- Support developers in creating documentation and technical blog posts based on their comfort level:
- Interview a developer and create a draft, or
- Edit copy written by the developer
- Be a resource for other teams to create copy for:
- Social media posts
- Marketing blogs
- Release blog post(s)
- Website copy
- Design and engineering copy

## Qualifications

- Have a Bachelor’s or Master’s Degree, preferably in Composition and Rhetoric, English, or Communication
- Have 5+ or more years in a training, instructional design, or technical writing related role
- Are a self-starter; motivated by results and challenging yet attainable goals
- Are passionate about all things writing and willing to wear multiple hats to get the job done
- Are enthusiastic about mentoring and coaching others
- Have 5 or more years in a training, instructional design, or technical writing related role
- Is a self-starter; motivated by results and challenging yet attainable goals
- Is passionate about all things writing and willing to wear multiple hats to get the job done
- Is enthusiastic about mentoring and coaching others
- Have experience working with Git, GitHub, HTML, CSS, JavaScript,, etc.
- Have a voracious appetite for learning, technology, and teaching
- Are not afraid to ask questions
- Not afraid to ask questions
- Take ownership!

## Learn more about us
Expand All @@ -52,15 +50,13 @@ Learn more about what it is like to work at Sourcegraph by reading [our handbook
## Interview process

1. You [apply here](https://jobs.lever.co/sourcegraph/933f214e-338b-422b-b5d9-0b01057576d3/apply).
1. We set up a 30-minute call to chat with you about Sourcegraph and to find out what you are looking for in your next role.
1. We review your portfolio of written materials.
1. We give you a writing project (~1-2 hours) to see how you would organize and revise an existing piece of documentation.
1. We schedule a 1 hr interview to go over your experience in depth and follow up on any questions from the writing project.
1. We schedule 2 hours of remote interviews over video chat across multiple days.
- Writing collaboration: We simulate a real-life collaboration with a member of our engineering team to see how you collaborate on writing projects.
- CEO/CTO: We ask you about what motivates you to do your best work, and we tell you more about the vision for the company.
1. We set up a 30-minute call to chat with you about Sourcegraph, our vision for the company, and find out what you are looking for in your next role.
1. We schedule a 30-minute interview to go over your experience and samples in-depth.
1. We schedule 2 video interviews:
- Collaboration exercise: We simulate a real-life issue with a member of our engineering team to see how you collaborate on writing projects (1 hr).
- Final: Our CEO and CTO ask about what motivates you to do your best work and your long-term goals (30 mins).
1. We check your references.
1. We make you a job offer.
1. We make an offer.

We want to ensure Sourcegraph is an environment that suits your working style and empowers you to do your best work, so we are eager to answer any questions that you have about us at any point in the interview process.

Expand Down

0 comments on commit 8ee0f4d

Please sign in to comment.