TPG Writing Guidelines

One of our goals is to provide a consistent and reliable experience for readers. The goal of any article can generally be summarized by this question:

What do we need to do (at a minimum) to teach a reader to safely, effectively, and efficiently perform this procedure?

Style Guidelines

  1. See currently published articles on theprocedureguide.com to see examples of how each section should be written
  2. All sections are kept to a minimum.
    1. The article is not designed to be a thorough review of the entire topic like UptoDate. It’s always a balance of providing a good foundation but making the guide practical and useful for everyday proceduralists/learners so they can get the procedure done quickly, effectively, and safely.
  3. Wording itself focuses on brevity and precision.
  4. All links/references/videos/etc should get straight to the point.
    1. EX: If a reference is included, make it clear to the reader what exactly they are looking for in that reference that is relevant.

Content Guidelines

  1. Plan what images (especially fluoro images) and diagrams should accompany the text. They should be complimentary but also somewhat independent:
    1. Images should match and explain what is described in the text
    2. But, many readers will skim images as a way to understand the procedure, so the images/diagrams should tell a story themselves.
    3. Provide relevant images for the article (we can edit/markup/anonymize them for publication)
  2. Whenever possible plan to use sections from other articles that might apply to the article that you’re writing:
    1. i.e., the anatomy section of a lumbar medial branch block and lumbar medial branch radiofrequency article will be the same.
    2. The common sections can be updated whenever necessary so all articles are using the best version, and readers get consistent information across the site.
    3. In these cases, just put [Common block] in the draft, so the common block can be pulled in later.
  3. Technique
    1. Sometimes there are variations on a technique (like unipedicular or bipedicular kyphos).
    2. Usually it’s best to outline an approach you are most comfortable with and that is accessible to the reader.
    3. Subsequent sections can be included under the Technique Section to outline other techniques with a focus on the differences.
  4. Tips
    1. This is a very important section, even though the content within varies a lot.
    2. These are the clinical pearls that help move a reader from barely completing a procedure to becoming proficient at it.
  5. References
    1. Include good primary literature whenever appropriate.
    2. Also include atypical sources like blogs, YouTube videos, etc. that might have relevant info.
    3. Relevant in this context is anything relevant to the procedure itself, and not a full academic review.
    4. Under each reference include commentary about what is relevant for that reference. (i.e., it might only be one section of one article that is relevant)

Author

  1. Provide a profile photo and bio for the Contributors page
  2. Please include your medical school, residency/fellowship training facilities, current country of practice, specialty/subspecialties

Publication

  1. All articles are published without author information and the site has a common Contributors page
  2. All content including diagrams and images are published under the creative commons license indicated on the site

Information to send in along with each article draft:

  1. Bio info as above
  2. Article images/diagrams and their relevant annotations
  3. Google wallet or zelle/chase pay info for paid articles (half paid at the halfway mark, and other half at the end)