Author Onboarding Hub
{"time":1662661995177,"blocks":[{"id":"6_yA3I5z-F","type":"paragraph","data":{"text":"We believe in empowering our authors to create their best work possible. This means we’re always happy to support you, and we encourage you to ask any questions that may come up during the writing process. Here are some foundations that will set you up for success."}},{"id":"rVZRfhBaZA","type":"paragraph","data":{"text":"Important: If a client work opportunity comes with a style guide, always refer to that first and foremost!"}}],"version":"2.25.0"}
{"time":1675434522122,"blocks":[{"id":"QaASjoZunV","type":"paragraph","data":{"text":"Voice makes us human. Voice helps us connect with one another and deliver information in an impactful way. As a technical writing service, it’s especially important that we use voice to humanize our communications so that we can create a meaningful relationship with our audience. The content that we write is technical, but we make it approachable to someone who is non-technical, even if they may not understand all the terminology."}},{"id":"NWJc7p4W0B","type":"paragraph","data":{"text":"Tone is how we demonstrate empathy. It’s how we identify with someone else. Getting it right means putting yourself in someone else's shoes and making sure that what you say adds value to their life. When writing or speaking for ContentLab, make your words..."}},{"id":"mDGaLdaqKq","type":"list","data":{"style":"unordered","items":["Authoritative: Our space can be complicated. Some players lean into jargon and opaque tech speak. We don't. We aren't interested in showing off what we know. We're interested in adding value to businesses—whether that means working with them or educating them. We do this by providing relevant information in a way that's easy to understand. Our content subject matter can be difficult. Our writing shouldn't be. That's why we're always clear and concise."]}},{"id":"q5cHYXOpgk","type":"list","data":{"style":"unordered","items":["Straightforward: We respect our audience's time. After all, they are busy. So we cut straight to the point without being curt. Clarity trumps everything else. If language doesn’t convey something of value, it fails. We don’t make things about us. We put our reader first. We consider their frame of mind and make sure to communicate with them from that point of view."]}},{"id":"IO1pUpr1th","type":"list","data":{"style":"unordered","items":["Authentic: We are unapologetic about who we are. We are a group of developers and technical minds that are brimming with enthusiasm. We passionately want to share knowledge and better our communities. We are human, and our voice reflects that. We're approachable, relatable, and helpful."]}}],"version":"2.25.0"}
{"time":1652291004384,"blocks":[{"id":"mWdn8vQ4Xe","type":"paragraph","data":{"text":"Articles and whitepapers of any length follow the same basic formula:"}},{"id":"Fyn5fIOEtn","type":"list","data":{"style":"unordered","items":[" Introduction: Grab the reader’s interest. Bring in the general topic of the article. Introduce the problem being solved and the point of the article."]}},{"id":"zz_Co309Q_","type":"list","data":{"style":"unordered","items":["Body: A discussion of the topic and the solution. Say what the evidence is, give an example of the evidence, and explain why the evidence is important."]}},{"id":"AhCrRN1kxw","type":"list","data":{"style":"unordered","items":["Conclusion: Remind the reader of the point of the article and the final solution. The conclusion may include a call to action. (AKA: What do you want the reader to do?)"]}},{"id":"JycfwXuPQK","type":"paragraph","data":{"text":"The most successful articles stick closely to the given outline and adhere to the given length guidelines. We always appreciate when authors are enthusiastic and want to write more, but we recommend not exceeding more than ~400 words above the target content length. "}}],"version":"2.23.2"}
{"time":1675434498667,"blocks":[{"id":"nQO5FoZeXd","type":"paragraph","data":{"text":"If your article contains code or includes screenshots, ensure the code works and that the screenshots reflect what will actually appear. Ensure that all technical information is accurate and up-to-date. If you have questions about a client’s technology, we will happily put you in contact with a technical expert to ensure you’re on the right track."}},{"id":"GXmley5yC6","type":"paragraph","data":{"text":"With very advanced topics, don’t assume a reader knows as much as you do. A good practice is to list any prerequisites that may be needed at the beginning of the article. For example, an article on web development can assume the reader knows HTML and JavaScript, but it would be worth pointing them to documentation before launching into a deep dive on installing components via NPM."}},{"id":"_haQUxdjZ4","type":"paragraph","data":{"text":"Avoid linking to Wikipedia to explain a concept. For the best article flow, briefly provide the explanation in your own words within the article itself. Use external links sparingly, and only when they are needed to support a point or are necessary. You may point readers to prerequisites or list further reading at the end of the article, but articles must be able to stand on their own."}},{"id":"D4_2JQyfp_","type":"paragraph","data":{"text":"We highly recommend running your article through a free proofreader such as Grammarly, Hemingway, or Ginger before submission. "}}],"version":"2.25.0"}