lightning-bolts/.copy-edit-stylesheet-checklist.md

Basic checklist/stylesheet used for copy editing BOLTs, temporarily included here for reference purposes.

• spelling
• typos
• sentence structure
  • sentence fragments
  • run-on sentences
  • dangling, misplaced modifiers
  • consistent paragraph tense (e.g. past, present, future)
  • passive voice (e.g. avoid 'we')
• capitalization
  • table of contents
  • headers
  • commonly forgotten: 'Bitcoin', 'Lightning', 'ID'
• punctuation
  • correct comma, colon, semi-colon, em-dash placement
  • appropriate use of parenthesis
• formatting
  • single spaces between sentences
  • consistent use of emphasis, strong, code, CAPS, 'quotes'
  • single line separators between paragraphs and page elements
  • type numbers (e.g. '1', '1s') rather than write numbers (e.g. 'one', 'ones')
• list structure
  • 2 spaces before item
  • indent 2 spaces
  • Requirements sections
    • colon after condition
    • comma before 'and' item
    • period at branch ends
    • example:

    A sending node:
        - MAY do this.
          - if this:
            - SHOULD do this.
          - else:
            - MUST do this,
            - and MUST NOT do this.
    

• links
  • broken links
  • link text
  • correct anchors/urls
• references
  • format e.g. ¹
• tags
  • consistent usage, e.g. [TODO:], [FIXME:]