Mattermost Handbook
Need help?How to spend company moneyHow to update the HandbookRelease overview
0.2.1
0.2.1
  • Mattermost Handbook
  • Company
    • About Mattermost
      • List of terms
      • Business model
      • Mindsets
    • "How to" guides for staff
      • How to set up a 1-1 channel
      • How to update the handbook
      • How to manage Handbook notifications
      • How to change mobile device
        • How to handle a lost mobile device
      • How to do a mini-retrospective
      • How to autolink keywords in Mattermost
  • Operations
    • Company operations
      • Areas of Responsibility
      • Mattermost Leadership Team (MLT)
        • MLT cadence
      • Company measures
        • Metrics definitions
        • FY23 goals board
        • MLT metrics
      • Company cadence
      • Company policies
        • Community response policy
        • Security policy
      • Company processes
        • Issue/solution process
        • Company agreements
        • Publishing
          • Public web properties
          • Publishing guidelines
            • Brand and visual design guidelines
            • Voice, tone, and writing style guidelines
              • Contribute to documentation
            • Confidentiality guidelines
          • Post-publication quality control process
      • Handbook processes and policies
        • Handbook onboarding
      • Fiscal year planning
    • Research and Development
      • Organization
        • Tech Writing
        • Data engineering
        • Delivery
        • Cloud Platform
        • Site Reliability Engineering
        • GRC
        • Product Security
        • Security Operations
      • Processes
        • Feature Labels
      • Product
        • Product planning
          • Product philosophy and principles
          • Prioritization process
          • Release planning process
          • Roadmap views
          • Release plan
          • Launch plan
          • Feature requests
        • Development process
          • Mobile feature guidelines
          • Deprecation policy
          • Mattermost software requirements process
          • Jira ticket lifecycle
          • Creating new Jira bug tickets
            • Priority levels for tickets
            • Jira fix versions
        • Release process
          • Release overview
          • Feature release process
          • Dot release process
          • Security release process
          • Mobile app release process
          • Desktop app release process
          • Release tips
          • Release scorecard definitions
        • How-to guides for Product
          • How to use productboard
          • How to record a roadmap video
          • How to update integrations directory
          • How to write a feature release announcement
        • Product Management team handbook
          • Product Management Areas of Ownership
          • Product Manager onboarding
          • Product Manager levels
          • Professional development
        • Product Design team handbook
          • Product Design levels
        • Technical Writing team handbook
          • Work with us
          • User interface text guidelines
          • Documentation style guide
          • Our terminology
          • Guidelines for PMs and developers
          • Guidelines for community contributions
          • Technical Writer levels
          • Docathon 2021
            • Getting started with contributing
        • Growth
          • A/B testing methodology
          • PQL definition
        • Analytics
          • Product Analyst Engineer levels
          • Looker
            • Dashboards
            • Explores
          • Telemetry
        • Developer relations
        • Product team hangouts
      • Engineering
        • Infrastructure engineering
          • Cloud infrastructure cost KPIs
          • Cloud data export process
          • Cloud churn process
          • Reliability Manifesto
          • Production Readiness Review
          • Infrastructure Library
        • Integrations team processes
        • Plugin release process
        • Data Engineering
        • Sustained Engineering
          • On call
        • How to go to a conference
        • Public speaking
        • Core contributor expanded access policy
      • Quality Assurance
        • QA workflow
        • QA testing tips and tools
        • Rainforest process
    • Messaging and Math
      • How-to guides for M&M
        • How to create release announcements
        • How to create screenshots and GIFs
        • How to write Mattermost case studies
        • How to write guest blog posts for Mattermost apps and services
        • How to write Mattermost recipes
        • How to compose tweets
        • How to create a split test for web page
        • How to run meetups
        • How to run executive dinners
      • Checklists for M&M
        • Blog post checklist
        • Bio checklist
      • Mattermost websites
      • Demand generation reporting
      • M&M Asana guidelines
      • Content marketing
        • How to use the editorial calendar
        • Content development and distribution
        • Video content guidelines
        • How to contribute content
    • Sales
      • Deal Desk
      • Partner programs
      • Lead management
    • Deployment Engineering
      • Overview
      • Workflows
      • Frequently Asked Questions
      • Playbook for MME Sev 1 Outages
      • Status Update Template
    • Program Management
    • Customer Success
      • Customer Support
    • Legal
      • Contracts
      • Ironclad Basics
        • Company-Wide Workflows
        • Sales Contracts and Workflows
        • Signing a Contract and Contract Repository
    • Finance
      • Budget
      • How to use Airbase
        • Access Airbase
        • Navigate Airbase
        • How to submit a purchase request
        • How to submit a reimbursement request
        • How to review a reimbursement request
        • Vendor portal guide
        • Frequently asked questions
      • Onboarding
        • Vendor onboarding
        • ROW staff onboarding
      • Staff member expenses
        • How to spend company money
        • How to spend company money: Internships
        • Corporate credit card policy
        • How to access Airbase
        • Gifting policy
        • How to book airfare and travel
        • How to reimburse the company
        • How to convert currencies
        • How to get paid
      • Arrange a Bounty Program
      • Naming files and agreements
      • Risk management
        • Mattermost U.S. consulting agreements
      • Operations playbook
    • Security
      • Policies
      • Privacy
        • Data deletion requests
        • Data subject access requests
      • Product Security
        • Product Vulnerability Process
        • Working on security-sensitive pull requests
        • Secure Software Development guide
      • Security Operations
        • User guides
    • Workplace
      • PeopleOps
        • HR cadences
        • HR systems
        • HR Processes
        • Working at Mattermost
          • Onboarding
            • Things everyone must know
            • Staff onboarding
            • Engineer onboarding timeline and expectations
            • Manager onboarding
            • Frequently asked questions
          • Learning and development
          • Mattermost communication best practices
          • Paid time off
            • Out of office email example
          • Travel
            • Business travel insurance
          • Leaves of absence
            • Pregnancy leave
            • Baby bonding parental leave
            • Jury duty
          • Workplace program
          • Relocation
          • Total rewards
        • Performance reviews
          • Formal review process
          • New staff performance review
          • Informal review process
        • Transfers and promotions
        • Offboarding instructions for managers
        • People compliance
      • People policies
      • Groups
        • Staff Resource Groups
      • Approvals and iteration
      • IT
        • IT helpdesk
        • Hardware and software purchases
        • Hardware buy back policy
        • Software systems
  • Contributors
    • Contributors
      • Equity, diversity, and inclusion
      • How to contribute to Mattermost
        • Community Content program
        • Documentation contributions
        • Help Wanted tickets
        • Localization
        • Contribution events
      • Mattermost community
      • Contributor kindness
      • Community systems
      • Guidelines and playbooks
        • Social engagement guidelines
        • Contribution guidelines and code of conduct
        • Mattermost Community playbook
        • How to run a Hackathon
        • Hacktoberfest event organizer guide for Mattermost
    • MatterCon
      • Staff information privacy management
      • Mattermost events code of conduct
      • MatterCon2021
    • Join us
      • Ice-breakers
      • Help Wanted tickets
      • Localization
      • Mattermost GitHub sponsorship
      • Things candidates should know
      • Staff recruiting
      • Recruiting cadences
        • Product Manager hiring process
      • Exec recruiting
        • EA logistics
  • Help and support
    • Contact us
Powered by GitBook
On this page
  • Goals
  • Process
  • A. (T-minus 20 working days) Blog Post Outline
  • B. (T-minus 11 working days) First Draft
  • C. (T-minus 10 working days) Head of PM, CPO, and MLT Reviews
  • F. (T-minus 2 working days) Set Up Blog Post in Wordpress
  • G. (T-minus 0 working days) Blog Post and Tweets Published
  • Checklist for review of draft
  • Style guidelines
  • Screenshot guidelines
  • Language guidelines

Was this helpful?

Edit on Git
Export as PDF
  1. Operations
  2. Messaging and Math
  3. How-to guides for M&M

How to create release announcements

50% Draft

Goals

  • Get the System Admin for Mattermost excited to upgrade or to buy E20 to empower end users

  • Everything should be ready to share

    • Every paragraph feels like it's ready to copy and paste into a tweet

    • Every person we thank who is on Twitter, we tweet to them

Process

A. (T-minus 20 working days) Blog Post Outline

  • Release Manager prepares bullet points for release announcement and shares with PMs

    • Do not include plugins that haven't been added to the Plugin Marketplace by code complete deadline to avoid cutting those plugins from the blog post draft in the last minute if any development issues arise

  • PMs start to draft the blog post and decide which sections of the release announcement will have an accompanying screenshot

B. (T-minus 11 working days) First Draft

  • PMs finish the blog post draft by writing a section for each feature

C. (T-minus 10 working days) Head of PM, CPO, and MLT Reviews

  • Head of PM, CPO, and MLT review the title, intro, and content

F. (T-minus 2 working days) Set Up Blog Post in Wordpress

  • Release manager checks that the guidelines in the Checklist for Review of Draft are met

  • Marketing (Justin) sets up the blog post in Wordpress and asks Release Manager to review

  • Marketing (Justin) ensures that the blog post is mobile-friendly by testing it on smartphone and tablet platforms

G. (T-minus 0 working days) Blog Post and Tweets Published

  • Release Manager publishes the blog post

  • Marketing (Justin) schedules tweets from blog post (Tuesdays 10am PT, and Thursdays 10am if there's extra)

Checklist for review of draft

The Release Manager (Amy Blais) owns the release announcement, including the following checklist items unless otherwise indicated:

  1. Exciting headline and subtitle

    1. Begin with a clear headline stating the purpose, e.g., "launching X", "ending support for Y", "announcing Z"

    2. Subtitle should focus on the System Admin for Mattermost deciding whether to upgrade or buy E20 to empower end users (customer focus)

    3. Subtitle summarizes the whole release, not just one or two main features. Lead with the most exciting/impactful new feature

  2. Compelling, specific one-liners

    1. Introduce features with compelling, concise, specific descriptions

    2. If the feature is a filler for a release, be vague and add it at the end of the blog post, e.g. "Performance improvements to mobile" (please avoid when possible)

    3. Experimental and Beta features should be at the bottom of the list

    4. Lead with verbs (e.g. "Find most recent messages faster")

    5. Categorize features under Enterprise Edition and Enterprise and Team Edition headings

    6. Clarify type of release (feature or quality) in the intro paragraph

  3. Body

    1. Promote E10 and E20 features by adding E10 Edition and E20 Edition labels throughout the blog post for relevant features

    2. All features PM team wants to highlight are included

      1. (PM team owns) Check for technical accuracy and statement of benefits

    3. The audience is primarily focused on admins, then end users

    4. No spelling errors or broken links

  4. Thank you's and call-to-actions

    1. Simple paragraph to call System Admins to upgrade

    2. MVP winner and security note (if applicable) are included

      1. Ask Hanna for an image of the MVP winner's coaster to include in a tweet

    3. (Marketing owns) All contributors are recognized with a screenshot

      1. Names should not be red-underlined (if they are, add them to the dictionary prior to taking a screenshot)

      2. Screenshot not surrounded by a border

      3. Below the screenshot, include a text version of their names in small font with a link to their GitHub handle

    4. (PMs own) Draft Tweet text for all screenshots and MVP winner included in a separate page

      1. Contains version hashtag, e.g. #mm520

  5. Screenshots

    1. Do not use screenshots rated at low quality

      1. (PMs own) Rate each image High, Medium, Low quality

        1. High - Beautiful, highly compelling, grabs attention in a social stream

        2. Medium - Tells a story clearly, readable text, right size

        3. Low - Bare minimum to call an image

    2. A screenshot should always be included for the feature that is highlighted

Style guidelines

  1. Highlight past successes: Cross link to promote traffic.

  2. Links tell a story: Links should indicate the content they lead to without clicking, avoid "read this blog post" and instead "learn more about the incident response alpha program".

  3. Actionable (e.g. downloading the latest mobile app release, including links).

  4. Clear, concise, and consistent throughout.

Screenshot guidelines

Language guidelines

  1. Use simple language with no buzzwords.

  2. Specify Desktop App or Mobile App if a feature is not dependent on the server release.

  3. Use common wording, e.g. say "Servers" instead of "Sites"; say plugins not plug-ins; say "Browser" instead of "Web App".

  4. Avoid phrases that are too vague, such as "Better messaging experience".

  5. Do not use internal names of features, such as "Unread toasts", "Deep linking".

  6. Say "You" instead of "Users" to talk directly to the reader.

  7. Say "AD/LDAP" instead of just "AD" or just "LDAP".

  8. "System Console" and "System Admin" should be capitalized.

PreviousHow-to guides for M&MNextHow to create screenshots and GIFs

Last updated 3 years ago

Was this helpful?

One or more people on the team put themselves in the shoes of a System Admin responsible for upgrading Mattermost and have read through the announcement out loud, clicked on the links, and feel we've met our

High Standards leadership principle
Follows screenshot guidelines
Learn how to create screenshots and GIFs