image-61
Editor's note: leave this image here or the next image will be hidden.

Thank you for sharing your expertise and your insights with the developer community.

Our publication will help you teach developers, designers, and data scientists around the world.

As one of the most-visited technology sites on the web, freeCodeCamp.org can help you reach thousands of people who will benefit from your wisdom.

Our nonprofit also has a large social media presence, strong accessibility, SEO, and an established reputation as a serious learning resource. All of these will translate into more readership for your tutorials.

In this style guide, we’ll give you tips for how you can maximize your impact by making your tutorials as strong as possible.

Substance wins the day

This is not a place for “blog-a-day”-style challenges or stream-of-consciousness observational posts.

Bring your facts. Bring your quotes. Bring your code snippets. Bring your data visualizations.

Years of data show that the more in-depth a tutorial is, the longer people will spend reading it, and the more likely they will share it with their friends.

If you’re not able to write at least 500 words about your topic, try doing some more research on it first.

By diving deeper and expanding upon your research, you’ll be able to deliver more insight to your readers.

Package your tutorial properly

People are busy. So you have to capture their attention immediately. How do you do that? With a compelling headline.

Headlines: The only part of your tutorial that 100% of people will read

Before you start writing your story, spend time crafting a compelling headline. Your entire tutorial will then spring forth from that headline and hook back in to support it.

Over the past 8 years, we've experimented with many formats. We've found that deep technical tutorials are the most helpful for our publication's readership of millions of developers around the world.

Here are a few headline structures we’ve found that work well for tutorials:

  • "How to fix…"
  • "How to build…"
  • “How to [task] with [tool]”
  • "How [something] works"
  • "The [adjective] guide to…"
  • “What exactly is [noun]?”
  • “Why [something] matters.”
  • "A history of [something]”
  • "The [something] Handbook" (for much longer tutorials of at least 10,000 words)

You can also include keywords in your title that people often search. Don't include too many ("keyword stuffing" isn't good), but it's worth thinking about what people are searching for that will lead them to your article.

Add your Cover Image

Once you’ve chosen your clear, informative headline, add a nice cover image. To do this, click the gear in the top-right corner.

Some contributors create their own cover art for their tutorial. A free site like Canva.com can help you with this process. (If you want to prevent the edges of your images from getting cut-off when your tutorial is shared on Twitter or LinkedIn, use an image aspect ratio of 1.91:1.)

Some things to keep in mind when creating your cover image:

  • Use nicely contrasting colors so the images/text really pop
  • Don't include too much text in your images – just focus on the main subject/keywords (So, for example, instead of including all this text: "How to Build a Food Ordering App with React", you could just say "How to Build an App with React" or "Build a React App".)
  • In general, remember: simpler is usually better for cover images. You want an eye-catching image that's easy to view/read on smaller devices.
  • You can use your cover images to help build your "brand" as a writer. If you create consistently designed images, people will often start to recognize your tutorials by the cover image alone.

If you don’t have an image, you can download a no-attribution-needed image from a site like Pexels, Unsplash, or Wikipedia, save it, and then upload it to Ghost.

Please do not hot-link images. Instead, download any images you want to use, then drag them into your tutorial on Ghost. This way freeCodeCamp can serve the images through our own reliable CDNs (for better performance and accessibility). Please try to keep image sizes under 1MB.

Also keep in mind that people using screen readers won't be able to see your images, diagrams, graphs, and screenshots. So please include a concise and relevant caption on all images that are important to understanding your tutorial. This is helpful for accessibility and allows you to point out critical additional information about the image.

Set Your Post URL

You can set your tutorial's URL directly. We recommend keeping these short and descriptive like “machine-learning-with-pytorch-tutorial” or “how-to-push-to-git-remote-repository”.

Choose Your Tags

You can choose one to five tags for your tutorial. Once you've chosen them, just let the editorial team know and we'll add them for you.

These tags will make it easier for readers to discover your tutorial through search and when browsing tags.

The first tag you choose is the most important, and it will show up above your tutorial, like this.

first-tag-example
What tags look like on freeCodeCamp's publication

Please don’t change any of the meta information in the menu. Our publication has sane default values for these.

sane-defaults
Don't alter these values in Ghost - the defaults are great.

Tips for writing a tutorial people will actually read

Grammar, spelling, and formatting do matter

It’s easier to read tutorials that are clear and properly formatted. Here are some tips to make your tutorial as readable as possible:

  • Keep it simple. Use simple, straightforward language whenever possible.
  • Use short sentences. Break down longer sentences into shorter ones. This helps people read faster and understand better.
  • Use short paragraphs. Break down longer paragraphs into one or two sentence paragraphs. Walls of text will make your readers abandon your tutorial or switch to “skimming” mode.
  • Clean up the punctuation. Too many exclamation marks can be distracting!!! Semi-colons are rarely necessary; just use a period instead. And ellipses are... well... usually a bit much.
  • Use sub-headings to structure your text. Our publication gives you both large and small heading sizes for your toolkit. Use large headings for main topics, and smaller sub-headings for sections within those topics.
    You can add headings with Markdown Syntax (## for H2, ### for H3, and so on), or by double-clicking on the text you want to make a heading. The following menu will appear:
Screen-Shot-2022-10-04-at-9.26.12-AM
How to add H2 and H3 headings in Ghost
  • Don't use excessive bold, italics, or both. Too much text formatting makes it hard to read. Especially if you use both bold and italics together. Use bold and italics separately, and sparingly.
  • Remove abbreviations. They make tutorials harder to understand. Spell out any acronym that isn’t well-known. Turn Latin expressions like “e.g.” into “for example” and “… etc.” into “like ...”

Use active voice whenever possible

People typically use active voice naturally in conversation. It's more casual and approachable, and implies action and authority.

So try to use active voice in your tutorials whenever possible.

Here's an example of active voice:

"You can install Node.js by following these steps."

Here's an example of passive voice:

"Node.js can be installed by following these steps."

It may seem subtle, but the active example connects more easily with the reader and helps them follow the instruction confidently.

Sometimes it helps to think of writing a tutorial like you're explaining something to a friend. You don't need to use overly complex language, you'll be friendly and polite, and things will flow logically.

Proof-read your tutorial. Then proof-read it again.

Some contributors write quickly so they can get their ideas down on paper. Other contributors do all their research before they write a single word.

Whatever your writing process, be sure to step away from your tutorial and come back with a fresh pair of eyes.

Read your tutorial over again. Then read it out loud. You'll be amazed at the little errors, misspellings, and awkward phrases you catch.

Add syntax highlighting to your code

You can create a code block by typing three backticks (```), followed by hitting the spacebar.

code-block
A code block in Ghost

You can even specify the programming language for which you want syntax highlighting.

For example, typing ```js will give you JavaScript syntax highlighting. And we support syntax highlighting for a dozen other popular programming languages as well.

javascript-code-block
A syntax-highlighted code block in Ghost with the programming language added

Stay on topic

Your readers’ time is finite. Help your readers to get as much value out of your tutorial as possible before they have to move on with their lives.

Keep your tutorials as step-by-step as possible

  1. Write a concise introduction that tells readers what they’ll accomplish.
  2. Use a numbered list like this one to indicate steps.
  3. Pack in as much detail as you can.
  4. Close out by reminding readers what they just accomplished.

Write longer comprehensive tutorials instead of multi-part tutorials

We’ve observed time and time again that people will not bother reading the second, third, or nth part in a series if they haven’t read all the previous parts.

At the same time, we’ve seen that very long, in-depth tutorials work surprisingly well. People will bookmark your tutorial or share it on social media so they can come back to it.

When people see that a tutorial is long, they’ll often assume the tutorial is serious and comprehensive. This inspires people to slow down and really spend time reading your tutorial. Many people will even open up their code editor and code along at home.

Keep it as G-rated as possible

The freeCodeCamp community is mostly adults, but there are some children here as well.

Try not to use profanity unless it’s in a direct quote, and steer clear of potentially offensive memes.

Finally, if a tutorial seems to violate freeCodeCamp’s code of conduct, we will immediately delete it. But we will save a copy of it and send it to you for your own records, so that you don’t lose your work.

Use No-Attribution-Needed images or images you have created yourself

You can include screenshots and other images you've created yourself. But if you don't own the rights to a photo, use a similar image that is no-attribution-needed instead. These don't require licensing fees or attribution.

Again, if you need a stock-image, some websites where you can find these images are Pexels, Unsplash, and Wikipedia.

Also, as a reminder, please do not hotlink images. Instead, just download any images you want to use in your tutorial, then drag them into Ghost. This way freeCodeCamp can serve the images through our own reliable CDNs (for better performance and accessibility). And please try to keep image sizes under 1MB.

Some images – such as webcomics – are created with sharing in mind. For these, you can insert the image then say "Image credit: XKCD" with a link to the specific page for the webcomic.

Always Credit Your Sources and Don't Plagiarize

Plagiarism is when someone misrepresents someone else’s writing (or image or code, and so on) as their own. It is a serious offense that gets people fired from jobs and kicked out of schools. And we take it just as seriously on freeCodeCamp's publication.

Few people have been brazen enough to attempt plagiarism on freeCodeCamp's publication. But there have been a few of them over the past 7 years. We've caught them, removed their tutorials, and banned them from our community for life.

Don't worry – you are not going to accidentally plagiarize anything. Plagiarism is an intentional act.

How to properly cite your sources

If you are paraphrasing (or quoting directly) something someone said in another tutorial, video, course, or other medium, you should credit them. This means adding a link to the original source and using pull quote formatting, like this:

"This game is controlled entirely by typing into a command line interface. Because the game is real-time in nature, this can lead to some intense moments of rapidly typing commands as you try to save your drones from danger." (Source: Quincy Larson)

This includes text (or code) taken from official documentation, StackOverflow, GitHub, and all similar resources. If you're copying and pasting something from a source like that, make sure you cite it and link to it.

Always attribute quotes to the people who originally said them. If it’s a multi-line quote, you can use pull quotes like these to break up longer paragraphs:

“When you have wit of your own, it’s a pleasure to credit other people for theirs.”
― Criss Jami

If your code is heavily inspired by (or borrowed from) someone else's code, you should credit them.

Before you publish a tutorial that leans heavily on someone else's work, ask yourself: does my tutorial expand substantially on that person's work? If not, it may not warrant a tutorial.

A final note on using other people's words: it's always better to use your own when you can. So rather than copy/pasting and quoting other sources excessively, try to digest the information and explain it in your own words. It'll help you understand it better, and you won't risk plagiarizing someone else's work.

But if you must quote or borrow from another source, make sure to cite it properly.

Some examples of plagiarism

Here are a couple examples of plagiarism – so, what not to do. The first should be fairly clear (it's copied word for word):

Original text:

Just a quick note before we get started: Instagram's desktop interface and mobile app are quite different. Most people use Instagram on their mobile device (from the Instagram app) because that's where you can actually post photos. (Source: Abbey Rennemeyer)

Plagiarized text:

Ok, everyone ready to learn about Instagram? Let's dive in!

Just a quick note before we get started: Instagram's desktop interface and mobile app are quite different. Most people use Instagram on their mobile device (from the Instagram app) because that's where you can actually post photos.

Now that we have that out of the way, we're ready to go.

As you can see, the plagiarized text is sandwiched between original text. It's tempting to add phrases or paragraphs that someone else has crafted really well. But unless you cite those parts, it's plagiarism.

The second example, below, may not stand out as much. But if you're paraphrasing someone else's words closely, that's still plagiarism.

Original text:

There are many reasons you might want to share photos and videos on Instagram.

Perhaps you're starting a business or launching a product. You might work for a company that wants to have an Instagram presence. Maybe you want to build your personal brand as a photographer, traveler, or artist. Or you just want to share what you're into right now via pictures.

Whatever the reason, Instagram is a great place to share ideas, messaging, and art online. (Source)

Plagiarized text:

There are lots of reasons to share photos and videos on Insta.

Maybe you're starting your own business or launching some product. Maybe you work for an organization who wants to have an Instagram presence. Or maybe you want to create your own brand. Or you just want to show what you're doing now in pictures.

Either way, Instagram is a great place to post those ideas, messages, and art online.

As you can see, the above text is heavily based on the original text. It might change a few words, or leave a few out, but it's clear that the person didn't write it on their own. Again, this is not OK, and would be considered plagiarism.

If you have any questions about what constitutes plagiarism, please do some research and make sure you know how to properly cite your sources and create original work.

No cross-posting, please.

Cross-posting is generally ineffective. If you want a lot of people to read your tutorial, we recommend you publish that tutorial in a single publication – whether that's freeCodeCamp's publication, or your own blog, or an online magazine.

A couple exceptions to this:

  • It can be worth it to cross-post a tutorial within a walled garden (that is not indexed by Google) like LinkedIn.
  • And if you want to feature your own writing from other publications on your own blog for potential employers to see, you can cross-post onto your own blog and just use a canonical URL to point back to the original publication. This will reduce the likelihood that Google gets confused and shows the wrong version in its results.

You can, however, take some of your personal blog posts on a similar topic (such as "Visual Studios Plugins" or "Advanced Bash Commands") and anthologize them (or join them together) into a single, longer freeCodeCamp tutorial.

Our philosophy is that since we are going to spend hours coaching you on your tutorials, meticulously editing them, and publicizing them to the broader freeCodeCamp community, we ask that you not cross-post it on open publishing sites like Medium.

Acceptable ways you can self-promote in your tutorial

freeCodeCamp.org is a donor-supported nonprofit. We don’t want anyone to get the impression that we do “paid placement” (we don’t) as this could discourage people from donating to us.

At the same time, we totally understand that you may want to publicize your latest book, course, or SaaS application, or get people to sign up for your mailing list or follow you on Twitter.

We ask that you keep this as tasteful as possible. It is perfectly fine to have a one-sentence call-to-action for your product at the end of your tutorial.

Don’t open your tutorial with a link to your product, as this looks spammy. And don't use affiliate links in your tutorial unless they are links to books or courses that you have personally created.

Also note that we do not allow branded accounts. We forbid any sort of ghost writing. And we will not transfer tutorials from one employee in a company to another.

And please – do not write stories on behalf of other people who have not yet earned their freeCodeCamp contributor account.

Note that for your own SEO purposes – unlike most popular websites – all links on our publication are rel="doFollow". This means that yes – each page you link to (including your own blog) will get a boost in Google rankings. Please keep this in mind and don't over-do it.

Finishing up the process

Once you’re confident your story is ready for readers, email a link to your draft to editorial@freecodecamp.org. Our editorial team will quickly go through and make edits to further strengthen your tutorial before publishing it.

The main things we care about are the headline and the opening paragraphs. If we notice any text formatting issues or grammatical errors, we’ll correct them too.

If we still think your tutorial needs significant work, we will tell you so, and you can then re-submit it once you've made those changes.

And finally, an important note: if a company is paying you to write an article and then try to publish it on freeCodeCamp's community publication, please disclose this to the editorial team when you submit your draft.

Other helpful tips

GitHub Markdown

Did you know you can use GitHub-flavored Markdown to compose your tutorial?

You can paste markdown into /news and it will be instantly converted to rich text.

You can also type markdown syntax at the beginning of a line - say # or ## for headings, or * for a bulleted list – then start typing. The text will change to your specified format.

Go easy on the embeds

You can embed things like tweets and YouTube videos if you want. Just click the + icon at the beginning of a new line, and you can choose from a variety of embedding tools.

This said, we encourage you to use these sparingly, for three reasons:

  1. The embeds make a call to an external service, such as Twitter, which may slow down the experience
  2. Many people who read  the publication are doing so using screen readers. A large portion of the developer community lives with visual impairments (or completely blindness). Embeds are less accessible than text.
  3. Each publication tutorial has an Accelerated Mobile Pages version, and the embeds may not show up properly there.

Use "You" instead of "We" when possible

Sometimes it's tempting to use "we" when writing a tutorial. "Now we need to install Node.js...". It's a natural way to communicate.

But we've found that using the 2nd person ("you") is more effective. It makes it feel like you're speaking directly to the reader, and gives the reader agency when following along with your guide.

There are exceptions, of course – we've used "we" a lot in this style guide, for example! :) But use your best judgement and try to use "you" when it's appropriate.

How to apply for a contributor account

If you don't have a contributor account yet, you can apply for one here.

Thank you for sharing your insights with the developer community.

We hope this guide will help you write better tutorial so the entire community can benefit from your insight.

Happy coding!

— The freeCodeCamp Editorial Team