Skip to content

RP Weight progress in roadmap epics

Keanon O'Keefe requested to merge 12.4-weight-progress-in-roadmap-epics into master

Engineer(s): @engineers | Product Marketing: @PMM | Tech Writer: @rdickenson

Content checklist

  • Description is informative and focuses on the problem we're solving and the value we're delivering
  • Check feature and product names are in capital case
  • Check headings are in sentence case
  • Check Feature availability (Core, Starter, Premium, Ultimate badges)
  • Make sure feature description is positive and cheerful
  • Ensure all text is consistently hard wrapped at a suitable column boundary
  • Screenshot/video is included (optional for secondary items)
  • Check all images size < 300KB compressed
  • Check if the image shadow is applied correctly. Add image_noshadow: true when an image already has a shadow
  • Ensure videos and iframes are wrapped in <figure class="video_container"> tags (for responsiveness)
  • Check documentation link points to the latest docs (documentation_link)
  • Check that documentation is updated and easy to understand
  • Check that all links to about.gitlab.com content are relative URLs
  • Run the content through an automated spelling and grammar check
  • Validate all links are functional and have meaningful text for SEO (e.g., "click here" is bad link text)
  • Remove any remaining instructions (comments)
  • Feature is added to data/features.yml (with accompanying screenshots)

Tech writing review

  • Verify Frontmatter:
    • Check that all links and URLs are wrapped in single quotes ' (documentation_link: 'https://docs.gitlab.com/ee/#amazing').
    • Check that name fields are wrapped in double quotes " (name: "Lorem ipsum").
    • No useless whitespace (end of line spaces, double spaces, extra blank lines, and lines with only spaces).
  • Links
    • Verify all links (including in feature description) work and that anchors are valid (note: the H1 (top) anchor on a docs page is not valid). Links should not redirect.
    • Verify that the feature is clearly mentioned in the linked documentation. If not, suggest a better doc link. If none exists, note this and raise an issue for creation of documentation if needed.
  • Content
    • Check that there are no typos or grammar mistakes, but style is up to the PM and PMM.
    • Ignoring style, verify that content accurately describes the feature based on your understanding of it.

Review

When the above is complete and the content is ready for review, it should be reviewed by Product Marketing and Tech Writing:

  • PMM review
  • Tech writing

References

Edited by Marcel Amirault

Merge request reports