Fueling innovative software
July 15-18, 2019
Portland, OR

Writing tutorial: Using blogging and great documentation to grow your open source project

9:00am12:30pm Tuesday, July 16, 2019
Open Source
Location: D138/139/140
Secondary topics:  Open Source

Who is this presentation for?

  • Open source maintainers and individuals who are interested in technical writing
  • Any level of programmer

Level

Non-technical

Prerequisite knowledge

  • Basic written communication and grammar skills (useful but not required)

Materials or downloads needed in advance

  • A writing utensil
  • A laptop (useful but not required)

What you'll learn

  • Find a consistent voice in order to engage a specific audience
  • Learn why you should blog and create strong documentation
  • Strategies for coming up with a blog post topic
  • Tips for creating engaging and understandable content and how to start building and growing a community of readers who will become contributors

Description

Writing blog posts and strong documentation for your open source projects is crucial for growing both a user and a contributor base. Your writing is the most effective way to communicate why and how people should use your project. But you’re a software engineer, not a content strategist. How can you effectively target the people you need to with your blog posts and documentation? Also, how can you accurately communicate the goals for your project?

Alison Spittel walks you through the writing process from deciding who you’re writing for to what happens after you press publish (or commit to GitHub). You’ll learn why strong documentation and blog posts are important for open source projects and look at some projects that have great content strategies and who your target audience is—whether that’s new developers or specialized experts. Alison helps you come up with blog post topics, how to make that content engaging and understandable, and how to reach that audience and grow a following.

After the hands-on portion, you’ll leave with the following completed worksheets:

  • A completed worksheet about your target audience and how to reach it
  • A list of possible blog post topics
  • An outline of the types of documentation needed for your project
  • An outline of a blog post
Photo of Alison Spittel

Alison Spittel

DEV

Ali Spittel is a programmer, teacher, and writer and a software engineer at DEV. You can read her writing, which had well over half a million readers last year, at dev.to/aspittel. She moonlights as a lead instructor at General Assembly. In addition to contributing to the open source DEV platform, Ali also maintains Learn Code from Us, a platform that highlights technical content creators who are members of underrepresented groups in tech. She’s also highly involved in the DC tech community where she’s the tech director for Women Who Code and is the founder of the Art + Code Collective and the Vue Vixens’ DC chapter.

Leave a Comment or Question

Help us make this conference the best it can be for you. Have questions you'd like this speaker to address? Suggestions for issues that deserve extra attention? Feedback that you'd like to share with the speaker and other attendees?

Join the conversation here (requires login)