This document should provide a set of standards for writing and designing content. It is meant to help maintain a consistent style, voice, and tone across our documentation.
See more information about writing a style guide.
For now this will just be a simple list of decisions we've made.
Use task-oriented or topic-oriented page titles and section headings by default. Titles such as Create a Mailing List, Manage Subscribers, or Mailing Lists are generally shorter, easier to scan, and produce clearer navigation menus and tables of contents than question-style headings like "What is a mailing list?", "How can I create a mailing list?"
Reserve question-style titles and headings for content intentionally organized around readers' questions, such as troubleshooting guides, or search-driven help pages where matching a user's wording actually improves findability.
As a rule of thumb, try to avoid making your documentation read like a list of Jeopardy! responses. If a question genuinely helps readers find the information they need, use it—but in most cases, a descriptive title or heading is the clearer choice.