Skip to content

Our workflow for producing great writing

To some extent, we customise our workflow to each project. Sometimes we have different roles, people taking on more than one role, or extra pieces. But in general these modified workflows are still based on this one.

Roles

  • Producer - talks to the customer, figures out requirements, and writes a brief
  • Engineering Writer - an engineer who builds a proof-of-concept project and writes an article about it
  • QA Engineer - a second engineer who follows the article as a reader would and checks for technical accuracy, code quality, and screenshot quality
  • Editor - a language expert improves the flow, fixes any language errors, and gives feedback to the writer, working with the writer on revisions to the text if necessary.

Pipeline

Each article goes through several stages, some of them optional. An overview of the article pipeline is below.

Ritza publishing pipeline

  • Brief: The Producer creates a brief explaining the goal of the article and defining any other requirements.
  • Draft: The Engineering Writer creates a POC if required, and writes a draft. At the end they do a full readthrough and runthrough of the article, as a reader would, and fix any issues before submitting it to QA.
  • DEO Edit (optional): If we need input from the customer, the editor will do a quick edit, fixing only any obvious grammatical mistakes or typos before we show the work to the customer.
  • Lead Writer Review (optional): Our customers are assigned one lead writer, but other writers or contractors may work on some articles, either to add capacity or because some specific expertise is needed. In this case, the lead writer will do a review of the article before QA. This step is not to replace either editing or QA, but to highlight any technical improvements to the article, especially those that require a deeper expertise of the customer's offering.
  • QA: The QA Engineer reads the article through the eyes of a reader, running all examples, ensuring that it renders correctly, updating screenshots with higher quality versions. Smaller issues are fixed by QA. Bigger issues are returned to the writer to address.
  • Edit: The Editor reads through the draft and fixes any grammatical or consistency issues. If necessary, they check edits with the writer, and discuss overall strucure with the writer.
  • Revise (optional): If the customer has feedback or wants changes, we do a revision step.
  • Publish (optional): If we are responsible for publishing, we set the article live.