ift-docs/resources/templates/doc-packet.md

name, about, title, labels

name	about	title	labels
Journey documentation (doc packet)	Request documentation for a new user journey. R&D SMEs use this template to provide the doc packet.	[Journey]	type:journey

Required sections are the minimum for the Docs team to start a draft. If any required section is left blank, Docs will publish a stub page and flag the gap.

This doc packet does not replace your PR review. After Docs writes the draft, you will review it for technical correctness on the pull request.

Even if you provide a draft covering the user journey, you must still fill out this template. Your draft may lack details that are important for the Docs team and the end user.

---

Minimum required information

1. Outcome and purpose

• What the user achieves:
• Why it matters:
• Key components:

2. Scope

• Repositories:
• Runtime target:
• Prerequisites:

3. Happy path

4. Verification

• Success command:
• Expected result:

---

Additional information (improves doc quality)

The next sections help the Docs team write a higher-quality document.

5. Configuration

6. Known issues and troubleshooting

7. Additional context

• Existing docs or specs:
• Hardware requirements:
• Estimated time to complete:
• Security notes:

---

Reminder: Completing this doc packet starts the documentation process. You will still be asked to review the draft on the pull request. For more information, see the contributing guide.