Skip to content

Rework written style guide #154

@SecondSkoll

Description

@SecondSkoll
  • Removal of examples from Spelling section
  • Removal of Other common terms
  • Removal of Other commonly referenced products/projects from Branding section
  • Refactor Contractions section to only reference terms you cannot use
  • Remove advice to use imperatives / gerunds for headings
  • Change date reference to the same as the Copy Style Guide (January 1, 2013)
  • Refactor code examples in documentation section
    • Use of prompt symbols - intent is to enable things to be well understood and able to be copied if we want it to be
    • Separate commands and output - why and mention terminal extension
  • Change Images section to refer to the strong reasons for including images in the repository - external contributions, etc. rather than errors from Google drive.
  • Remove Words and phrases to avoid
  • Remove Lone “this”, “these”, “those”, “that” section
  • Remove Active and passive voice section
  • Refactor admonitions section to advise on specific admonitions to use, and to avoid hint/tip
  • Add clarification to Screenshots under Interacting with UI elements - Don’t use screenshots unless there isn’t a better way of indicating the interaction or interface you are showing
  • Swap advice on Using UI elements as the English words
  • Remove Click vs. Tap vs. Select section
  • Remove Checkboxes section
  • Remove Keyboard shortcuts and keyboard keys
  • Remove Icon vs Button
  • Remove FAQ section
  • Add section on bulleted and numbered lists
    • Bulleted lists for definitive lists
    • Numbered lists to be used rarely

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions