Appendix C - Drafting with ChatGPT

Codex is the recommended tool for this workflow because it can inspect and edit the local repo. ChatGPT can still help when you want to turn rough notes into an outline or draft before applying changes locally.

Use ChatGPT for:

• outlining a topic
• rewriting rough notes into clearer troubleshooting language
• turning screenshots or Slack notes into questions for the SME
• drafting a proposed action flow before Codex edits the repo

Do not assume ChatGPT knows this repository’s directory layout, topic structure, review workflow, or CI checks unless you provide that context.

For a new guide, open a PR with the information available and manually assign the relevant FSE found in Technical Contacts by System. The FSE completes the guide on the same branch and coordinates TW/SE2 review and merge.

Prompt template

I am drafting a service_docs troubleshooting topic.

Audience:
- Maintenance Technicians who may read and act directly
- Service Engineers using the page as a reference

Please help me outline the topic, but do not invent technical steps.
If something is missing, list questions I need to answer.

Known information:
- Alarm or issue:
- Asset type:
- What the reader sees:
- Likely cause:
- Checks the reader should perform:
- Repair or work order:
- When to escalate:
- When to return to service:
- Screenshots or notes:

How to use the result

1. Ask ChatGPT for an outline first.
2. Ask it to convert the outline into concise troubleshooting prose or a decision flow.
3. Paste the useful parts into Codex.
4. Ask Codex to inspect the repo and apply the change using local conventions.
5. Review the rendered page and the diff before opening a pull request.

What to paste into Codex

After ChatGPT helps shape the content, use Codex for the repo work:

Use the draft below to create or update the service_docs topic.
First inspect nearby topics and repo conventions.
Do not invent missing technical details.
If the draft conflicts with existing repo patterns, explain the conflict before editing.

[paste the ChatGPT draft here]