Skip to content

2020 website content publishing process

kodiakhq[bot] edited this page Oct 25, 2021 · 17 revisions
Table of contents

This is the standard publishing process for the Carbon for IBM.com website

Resources

  • Idea and retro Mural board for publishing is here
  • The Box folder for working items is here

Timeline

  • Estimated # of sprints: 2 per website page
  • Most of the heavy lifting will be in collating, writing, and asset production.
  • Reviews will depend on availability of designers and stakeholders.
  • The "Sprint order" is not a delivery commitment but rather a best practice.  The timeline is subject to change based on the complexity of the task.

Process

Task Stage Tool Action Dependencies Contributor/Task owner Sprint & LOE
Initial research Research/Investigate Ideation board Identify adopter pain points, ideate, Identify proper IA placement, and identify proper level of details and fidelity Adopter needs and pain points Assignee/Content creator Ideation
Publishing agreement Planning Ideation board Get the content needs agreed by the DDS leaders and create proper Epic or Task issue on Git for prioritization Proposed by the website stream lead and approved by the DDS leaders Planning
Collect content documentation Research Agile board Gather designs and specs, gather content guidance (and/or content model), gather developer notes, and gather research notes Designer, content strategist,  developer, and researcher of pattern must be available to share documentation and relevant assets. contributor may need to write documentation Task assignee/Content creator 1  (week one)
Fill in the content template Creation Agile board and Box document Take all documentation and assign to pattern content template and add new subsections as per pattern needs See above Task assignee/Content creator 1 (week one)
Produce supporting assets Creation Agile board, Sketch app, or Photoshop Do's and don'ts, visuals to support each sections and/or subsections of written guidelines, and Video/diagram/specs Contributor to share [draft] assets and work with the Visual/UX Designer to ensure the assets are accurate Task assignee/Content creator 1 (week two)–2 (week one)
Create draft design mockup Creation Agile board or Sketch app Create mockup of page with content and visuals and share mockup with all contributors for feedback Availability of all contributors Task assignee/Content creator or Visual/UX Designer 2 (week one)
Share with the team to get feedback Review 2 (week one)
Update content or design Creation Agile board or Sketch app All contributors have reviewed  Task assignee/Content creator or Visual/UX Designer 2 (week two)
Share with Carbon, IDL, ibm.com adopters Review Gather feedback from teams on content and page design Task assignee/Content creator or Visual/UX Designer 2 (week two)
Finalize documentation and update copy Creation Agile board or Sketch app Add any additional Carbon comments, ensure language and style is consistent and updated, and writer review and proof Availability of Carbon Task assignee/Content creator or Visual/UX Designer 2 (week two)
(Optional0 Review with IDL governance board Review Share/present pattern to IDL board for approval Task assignee/Content creator or Visual/UX Designer 2 (week two)
Finalize content and documentation Creation Agile board or Sketch app Add any additional Carbon Board comments, ensure language and style is consistent and updated, writer review and proof, and review with DDS leaders for approval Task assignee/Content creator or Visual/UX Designer 2 (week two)
Create a new page and publish on website Publish Agile board and GitHub (markdowns and html code) Publishing with markdown by Visual/UX Designer, publishing with code by a Developer (as needed), PR preview link is ready, and PR review request set Final pattern documentation has been reviewed and approved, patterns and guidelines have been approved by Carbon review board, and all assets must be made available to publishers Task assignee/Content creator or Visual/UX Designer 2 (week two)
Website page go live Release Agile board and GitHub QA via the preview link and approve the PR and merge the PR to master branch Jenkins built 2 (week two)
Get adopter feedback Review Ideation board and Cupcake website Update roadmap / GitHub, Slack communications, spot opportunity and make plan for improvement,and Catalog/consolidate feedback Task assignee/Content creator or Visual/UX Designer Iteration starts

Website guidelines

Publishing guidelines (6)

Functional specs

Layout component (37)
Service (3)
UI component (34)
Utility (5)

Additional components

Carbon component (19)
Design only (9)
Feature flag (3)
Clone this wiki locally