Skip to content

Instantly share code, notes, and snippets.

@dabbott
Last active June 22, 2020 22:23
Show Gist options
  • Save dabbott/dc3e633f85f8e98825432de1146ec7cb to your computer and use it in GitHub Desktop.
Save dabbott/dc3e633f85f8e98825432de1146ec7cb to your computer and use it in GitHub Desktop.
Writing style for .express sites
  • Cover just one topic per section, and keep text short. Imagine each section needs to fit on a single slide: e.g. https://www.javascript.express/types

  • Multiple related topics should go on the same page: e.g. https://www.react.express/jsx

  • Prefer many small examples that each illustrate a single idea, over a single large example

  • We'll put the small examples together in "exercise" sections: https://www.javascript.express/exercises/transactions

  • Topic/overview sections don't necessarily need an example, but every other section should have an example.

  • Use "we" instead of "you" for most content.

    E.g. "In this section, we'll cover how to render React components." instead of "In this section, you'll learn how to render React components"

    The exception is if we're directly addressing the reader: "If you don't already have node.js installed, install it now"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment