Product Assignment: Documentation Writer

We are the documenters... we ensure that the most important parts of how our application is supposed to work never gets forgotten.


Expectations / Description

Escalation Engineers who take on the Document Writer assignment work to ensure that escalations caused by lack of product or process knowledge are rare. They proactively update existing documentation when they see something incorrect out of date, create documentation (Guru cards, Loom videos) relevant to Escalation work (mitigations, processes, etc.). They work with Product Marketing/Technical writing/other squads to close knowledge gaps in the Help Center/Guru.

One Number

  • Trust Score of the Product Team Guru Boards (how this will be measured... coming soon)

Success:

  • No one on the P&E team has to ask how new functionality is intended to work
  • None of the direct stakeholder (enablement, product marketing, and customer support) has to ask how launched functionality is intended to work (can be measured with a decrease in tickets that could be solved by having documentation in place)
  • Documentation is created, reviewed, and added to Zendesk Guide before the feature is launched and passed to Customer Support and Customer Experience prior to launch to create support articles

Note: The scope of this Assignment is it is responsible for creating a manual that inspires the customer-facing and enablement documentation but is NOT responsible for writing customer-facing and enablement documentation

With every launch and every new feature, there are many details about the feature that we on the product have in our heads. These include:

  • Overview of the feature
  • How the feature works
  • Screenshots
  • Demo Video
  • and more!

We have a goal to properly document the feature launching for both P&E and inter-departmental stakeholders.

Things you might deliver/do

  • Create a story for creating documentation in each epic
  • Create documentation and move it through the review process
  • Add documentation for each feature to Zendesk Guide
  • Maintain documentation in the now and future
  • Share documentation easily with stakeholders via Zendesk Guide
  • The Feature Documenters (at least one person from each squad) will get together to create a Feature Documenters Handbook where they will agree on how documentation will be written, organized, and styled in the internal knowledge-base (Zendesk Guide).

Requirements

  • Documentation Writer's must have a position with the reach of 1.1 or higher
  • Documentation Writer's must be milestone 2+,Product Knowledge
  • Documentation Writer's must be milestone 2+,Communication
  • Documentation Writer's must be milestone 2+,Copywriting

Configuration Health

  • ✅ Has 3 Abilities
  • ✅ Is a part of 8 Positions
  • ✅ Has been referenced in 2 pieces of public recognition
  • ℹ️ No one has reacted to this Assignment
  • ℹ️ No one has an official rating on this Assignment
  • ⛔️ Last updated: over 2 years ago
  • ℹ️ Never conversed about

Examples / Observations

An observation relating to  Documentation Writer  has not been publicly recognized yet.

Official Documentation Writers

Manager Details:
This section is for CareerPlug folks only. Sign your team up to find your Gruuv!

Teams needing a Documentation Writer

This section is for CareerPlug folks only. Sign your team up to find your Gruuv!

Positions that reference being a Documentation Writer

This section is for CareerPlug folks only. Sign your team up to find your Gruuv!

Conversations about Documentation Writer

This section is for CareerPlug folks only. Sign your team up to find your Gruuv!

Embed code

<iframe src="http://ourgruuv.com/our/roles/10211?embed=true&name=documentation_writer&organization=careerplug"></iframe>