• bulleted lists

    Refer to this article from NN/g on presenting bulleted lists.

  • Debian and Ubuntu versions

    Refer to Debian and Ubuntu versions primarily by their numbers, and additionally by their codenames.

    • For example:
      • Tails 3.0 is based on Debian 9 (Stretch)
      • Tails Installer is available on Ubuntu 15.10 (Wily Werewolf) or later.

  • GNOME applications: Files, Disks, etc.

    GNOME applications that have a common noun as their name (like Files or Disks) can be confusing when referred to in the documentation.

    Make sure to clarify that you are referring to an application (and not, for example, a set of files or disks):

    • For example:

      • In the title of sections
      • When first referring to the application in a section
    • Use:

      • The Files browser
      • The Disks utility

    Otherwise, use the short name of the application as it appears in the menus when giving instructions to be executed inside Tails.

    • For example:
      • Open /live/persistence/TailsData_unlocked/dotfiles in Files.

    Prepend "GNOME" when giving instructions to be executed outside of Tails.

    • For example:
      • Install GNOME Disks in Debian.
  • graphics card

    And not graphics adapters, graphics, graphical hardware, or video card.

  • procedures (a series of steps)

    • Keep the number of steps low within a procedure (for example, below 10, ideally 7). For longer procedures, split them and give each section a title.

    • Add a blank line between each step.

    • Rely on the automatic numbered of Markdown and number all the steps with 1.

    See also the Microsoft Manual of Style: Procedures and technical content.

    For example:

1. Make sure that you are connected to the Internet.

1. Start Software Sources.

1. Click on the PPAs button and then choose to Add a new PPA….
  • network interface, Wi-Fi interface

    And not card, device, or adapter.

    Still, USB Wi-Fi adapters are USB dongles that provide a Wi-Fi interface.

  • persistence feature

    To refer to the features available in the configuration of the persistent storage.

    The word persistence can be omitted if it is redundant from the context (for example on configure).

  • serial comma

    Place a serial comma immediately before the coordinating conjunction (usually and or or) in a series of three or more terms.

  • startup options

    To refer to the kernel command line options that can be specified from the Boot Loader Menu.

  • Tails Greeter

    Without an article. Not the Greeter. Note the formatting as an application.