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.
- 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
Customer Advocate Internshipintern
We're looking for a passionate customer advocate to join our Customer Success team and act as the voice of ReadMe this summer! You'll work directly with customers (we have some awesome ones!) to develop relationships, solve complex problems, and create an amazing customer experience!
Be the voice of ReadMe and support our customers:
- Help manage the support queue and act as the face of ReadMe to our thousands of customers.
- Become a product expert. Know the product inside and out so you can answer any and all questions that come your way.
- Create detailed knowledge base articles on frequent support topics.
- Solve technical questions and report bugs.
- Experience in a client-facing role
- Experience with developer tools
- Proven record of customers that trust and respect you
- Comfortable talking to developers and technical users
- Hands on, high energy, passionate, creative problem solver
- Experience working with/at early stage startups
We'd love to have you join our Customer Success team this summer!
We’re looking for a developer who loves to write! We’re searching for someone who is good at explaining complex topics in a way that junior engineers would understand and senior developers would still find engaging. If you can impart wisdom, clarify something complex and crack a joke in the same sentence… you’re what we’re looking for.
The job will be a part-time remote job, and you can write as much or as little as you’d like. At first the medium will be blog posts, but we’d love to expand into content marketing sites, open source projects, and whatever else makes sense to help get the word out!
(Please not that we're only looking for actual developers who like to write... we already have non-technical blog writers!)
- API best practices
- Swagger (how, why, etc)
- Reviews of developer tools
- New feature announcements
- In-depth guides on how to use our product
We're looking for an array of writers! We already have a blog that chugs along, so we're just looking for people to contribute to it... so we're flexible! We're just looking for opinionated people who want a platform to help people learn.