Author responsibilities

Engineers, Service Engineers, and Technical Writers can create topics and propose technical changes through PRs. The responsibilities differ for a new guide and an edit to an existing guide. See Guide ownership and workflow for the Who owns what table and both workflows.

When initiating a new guide

Create an initial draft with the information available and open a PR. Always use Technical Contacts by System to find the relevant FSE and assign the PR to that FSE manually.

The FSE reviews and revises the draft on the same PR branch, completes the service and maintenance guidance, coordinates additional technical input, and takes the PR through TW/SE2 review and merge. Creating the initial draft does not make you responsible for completing every part of the guide.

The FSE moves the PR to Waiting for TW Review when the guide and checks are ready. FSE assignment does not replace the designated TW or authorized SE2 review, and does not add a separate approval requirement.

When editing an existing guide

You are responsible for your proposed change and for following it through checks, requested updates, review, and merge. Verify:

• Technical correctness: The proposed content matches the real failure mode, hardware, repair, and escalation path.
• Complete troubleshooting paths: Every affected path ends in return to service, maintenance, or escalation.
• A readable rendered flow: Normal reader paths move top-to-bottom in the browser.
• Correct metadata: Status, MX approval state, hardware labels, and applicable alarms are accurate. There are no guide-owner fields or body ownership labels.
• Appropriate scope: The change addresses the intended failure mode and preserves unrelated technical behavior.

Consult FSE or Engineering contacts from the central directory when clarification or expertise is needed. Additional technical review is optional rather than a blanket requirement for every update. Request the specific information needed rather than transferring the whole documentation task to Engineering.

What reviewers contribute

• Technical Writers maintain documentation quality and consistency, review writing and usability, and remain accountable for the published deliverable.
• Authorized SE2 reviewers validate technical accuracy, troubleshooting logic, safety wording, escalation targets, repair guidance, and return-to-service decisions.
• TW/SE reviewers may directly fix formatting, spelling, grammar, and wording that does not change technical meaning. Technical changes follow normal review.
• Automated checks and AI reviews help identify problems; they do not replace human judgment or TW/SE approval.

After publication

Service Engineering collectively owns the guide’s operational content and upkeep under TW oversight. FSEs and software/hardware engineers provide technical expertise when needed. Creating an alarm, initiating a draft, or appearing as a technical contact does not make someone the ongoing individual owner of a guide.

Your working loop

1. Check whether the change needs a new guide or belongs in an existing one. Check All Open Pull Requests for work already in progress.
2. Follow the New Guide or Existing Guide workflow on Guide ownership and workflow.
3. Use the Guide content checklist when the content is complete.
4. Handle checks and automated-review findings, then use the PR readiness checklist before human review.
5. Follow the handoffs in PR workflow. The FSE completes new-guide PRs; the author completes existing-guide edits.