Craft beautiful documentation with us

Learning a new API or code library should feel magical

As developers, we spend most of our time either reading documentation or writing it. Documentation is the UX we use when interacting with a new API or programming language, yet it’s almost always relegated to an afterthought.

We don’t want to just make writing “good documentation” easier – we want to change what “good documentation” even means. Let’s replace paragraphs of text with simple onboarding flows, custom-tailored code examples, intuitive SDKs and interactive UIs. (Here's some things we're excited to work on.)

Developers are just like regular consumers. They like simple, beautiful, easy-to-use products, too.

We have a long way to go still. That's why we need you!

209 Kearny St #2, San Francisco, CA

Y Combinator Winter 2015

Seed funding (Raised over $1MM)


Competitive salary and significant equity

Good work/life balance. We don't work on weekends.

Quarterly product roadmap retreats at locations like Santa Cruz or Tahoe.

Unlimited days off. And don't even think of coming in on your birthday!

Ability to work from home a few days a week, if you're more productive that way.

Stay healthy! Paid monthly gym membership.

Full healthcare, vision and dental coverage; paid maternity / paternity leave.

API Engineer

We want creating a ReadMe to be the first thing a developer does when it comes time to create an API. We don't want to just be documentation... we want ReadMe to be the entire UI for APIs.

ReadMe needs to start collecting documentation in the form of semantic metadata, rather than paragraphs of text. Swagger is emerging as the winner, so we'll start with building tooling around that. You should have a love for Swagger in concept, but a healthy wariness for it in practice: Swagger is confusing and tough to get started with, and we need to make it much easier for people to understand and implement.

We want to normalize APIs on the documentation/SDK layer. This means that anyone should be able to write their APIs however they want (API key as a header? sign requests with JWT? be x-www-form-urlencoded?), however all APIs on ReadMe should feel consistent to end users. We'll do this through a combination of things, including generating SDKs and building tooling around authentication.

Lastly, we want to start pushing our own philosophies... which you'll craft. APIs are simple, however people find infinite ways to complicate them. We'll never force anyone to do things a particular way, however going forward we want to start promoting best practices that will make working with ReadMe easier and better.

It's important that you love APIs, but focus on usability and ease-of-use rather than complexity.


Responsibilities

  • Making our "Try It Now" feature work like a charm in any situation
  • Auto-Generating code samples and SDKs in various programming languages
  • Allowing people to manage their API keys in ReadMe
  • Tackle the issue of authentication... it's confusing, and a huge barrier to entry for APIs
  • Work on leveraging what we know about the API and the user to custom-tailor documentation
  • Keep up to date with API technologies, and making that simple for everyone to understand and work with
  • Writing blog posts and (if you want!) speaking at conferences about APIs

Freelance Writer

We are hiring freelance writers to contribute to our blog! ReadMe is a small startup developing our voice in the API and developer tool world. We’re looking for contributors to help us share new ideas, deep-dive explanations, and thought pieces with our community.


The Role

  • Freelance/contract role to be completed remotely (but you’re welcome to visit us in our SF office if you’re nearby!)
  • Write short and longer-form stories for our blog and other editorial outlets
  • Responsible for 1 deep-dive and 1 short-form post per month
  • Have a self-driven process for reporting and researching stories
  • Learn, maintain, and develop the voice of ReadMe in collaboration with the team.
  • Source story subjects and ideas for yourself, along with ideas presented by the team.
  • Give and receive feedback, respectfully.
  • Be a great everyday written communicator. As a remote role, we’ll be talking mostly over email, Slack, Trello, and occasionally Skype.
  • You get credit for every post you write! 

You are...

  • a seasoned writer with experience writing for publications and/or a developer with writing chops and ideas on the future of documentation
  • detail oriented and a sharp copy-writer of your own writing.
  • adept at writing posts that embody ReadMe's voice and fit well with the rest of our content. Your posts effectively articulate customer-facing messaging, providing value to readers without sounding overtly advertorial.
  • familiar with our field; APIs, documentation, developer tools. You have deep technical understanding and are a quick learner when researching new topics.
  • able to communicate via email, Slack, and Trello.
  • reliable. You never miss a deadline.
  • team oriented.

Requirements:

  • A portfolio of your work. Send two samples you’re most proud of.
  • Understanding of ReadMe, it’s voice, it’s users.
  • Knowledge of developer tools, documentation, APIs.
  • BA degree or equivalent experience.
  • Ability to work independently, communicate across time zones.

Full-stack Node/JS Developer

We're looking for a product-focused Node/Angular developer to join our team. ReadMe replaces paragraphs of text with custom-tailored developer experiences. The role requires both frontend (Angular) and backend (Express) programming. Having a good sense of product and design is vital.

We're a small startup with a big reach, so you'll be able to have a huge impact. Working at ReadMe means there's a lot to be done, but also autonomy, flexibility, and a clear mandate to tackle big problems.


Responsibilities

  • owning major feature development. You'll lead the development of things like syncing API references from Github, creating easy onboarding flows, and new integrations.
  • helping to build a developer-focused company culture.
  • leading technical initiatives that grow and scale ReadMe.
  • Building a documentation platform that redefines the way people consume APIs and documentation.

Requirements

  • Passionate about making products people love
  • Previous professional experience as a programmer
  • You have the ability to take ideas from conception to release
  • Your GitHub is full of everything from embarrassing hacks to impressive Open Source contributions
  • You stay up to date with the latest web technologies
  • Comfortable in Angular/Node
  • Understanding that roles are flexible and willing to take on new opportunities as ReadMe grows!

Bonus Points

  • Experience at early stage startups
  • Experience with developer tools
  • love of owls!

Sales Lead

We're looking for a sales leader to join our team as our first sales hire! You'll be working with corporate customers, enterprise customers, and hot startups as their main point of contact. Our customers are often developers or product managers, so you must be comfortable talking technically about how we can help build products and businesses. You'll develop trust and meaningful relationships with our biggest customers.


Responsibilities

  • work directly with customers via phone, email, and in-person on a daily basis
  • be the main point of contact for prospective and current enterprise and corporate customers.
  • handle inbound sales and work with customers to develop enterprise plans
  • act as a customer advocate
  • develop outbound sales strategy and create sales opportunities
  • maintain engaged relationships with current customers to develop better solutions
  • manage the funnel of opportunities to help prospective users move through the sales cycle

Requirements

  • 3-5 years of technical sales and account management experience (we'll be really excited if it's with SaaS or dev tools)
  • comfortable selling to developers and technical buyers
  • hands on, high energy, creative problem solver who gets things done
  • great communicator with ability to lead others
  • willing to work independently within a small team
  • understanding that roles are flexible and willing to take on new opportunities as ReadMe grows!

Bonus Points

  • experience with developer tools
  • experience working with/at early stage startups
  • love of owls

Some Of Our Favorite Customers

ReadMe currently provides the developer experience for thousands of awesome companies.




Need beautiful documentation?

You may not be looking for a job, but everyone needs beautiful documentation!

Sign Up for ReadMe!