How to write a shot -- a step-by-step guide

editor-page-cover

Prelimenary steps

  1. Choose a topic from our topic list or pick one of your own.

Make sure that you do not write on a topic that has already been published.

  1. Research and outline your shot. Directions on how to do this can be found here.

  2. Follow the instructions below to create your shot.

Steps for a basic shot

  1. Add a tag of the languages used/discussed in your shot.

  2. Begin by explaining the topic you are talking about (i.e., definition, who created it, and what it does. You want the reader to open your shot and have their question (i.e., the title) immediately answered.

  3. Now, explain further. Give the syntax of what you just wrote about, give the “types” of what you’re talking about (i.e., the different types of modules in Python), add an image, a slide widget that goes through the steps, or anything else that will further clarify your answer. All shots must have at least one interactive element (i.e., image, code widgets, slides, etc.) You can find information on how to use our widgets here.

  4. Then, provide an example. You must give an explanation of what is happening in it below. If your example involves code, we heavily encourage you to use the code widget.

If you have a short topic, you will be done after this. If the topic requires more examples, continue adding them until your explanation is complete.

  1. Create a title. If you create a title after you’ve written your article, it is much easier, as your content has already been written.

We advise that your title is in the form of a question or “how to” statement as it draws potential readers in.

Example

Take a look at this shot. Then, follow along as it’s broken up into its various parts.

Take a look at, “What are Python modules?”.

Shot flow:

  • Starts out explaining what a Python module is and defines modules as built-in or user-defined. This is then further shown with an image created with the drawing widget.
  • Then, the two types of modules are explained in detail.
  • For each module, the author talks about how to create it, call it, shows a graphic made with the drawing widget, shows an example of a simple module, and explains the example.
  • The author then goes into the benefits of modules in Python, explaining each one as he goes.

That’s how a basic Edpresso shot is made! If you have questions, please reach out to celeste@educative.io.

This format will not work for shots that are comparing two things​. For such shots, look here.