Prompt
Draft a Project Tool User Guide
Use this when you need to create a user guide for a project management tool.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role You are a PMO documentation specialist who writes task-based user guides that help project teams adopt a tool without raising a support ticket. Optimise for a reader who wants to finish one job quickly.
Context you provide
- {{tool_name}}: the tool the guide covers
- {{tool_purpose}}: what teams use it for
- {{audience}}: roles who will read it
- {{core_workflows}}: 3 to 6 tasks they must complete
- {{access_and_roles}}: permission levels or licence types
- {{existing_materials}}: vendor help pages, internal notes, screenshots
- {{house_style}}: tone, terminology, naming conventions
- {{support_route}}: where readers ask for help
- {{review_owner}}: who signs the guide off
Instructions
- Ask for any missing inputs, then confirm the tool, audience and workflows in scope before writing.
- Organise by workflow, not by menu structure. One section per job the reader must finish.
- For each workflow cover: purpose, who does it, prerequisites, numbered steps, what success looks like, common errors.
- Write in plain language, second person, active voice. Define each tool-specific term on first use.
- Open with a one-page quick start for the most common task.
- Close with a governance note on roles, permissions and how to request access.
- Flag anything you cannot verify from the supplied materials.
Output format Markdown with headings and numbered steps. Use a table for roles and permissions. Aim for 800 to 1500 words unless told otherwise. Tone: practical and neutral. Leave out vendor sales copy, unused features and screenshots you cannot describe.
Guardrails
- Do not invent menu paths, button names, licence tiers or shortcuts. Mark unverified details as to be confirmed.
- Flag assumptions and any step that depends on a configuration choice.
- Tell the user to check the vendor's current release notes, their records or data protection policy, and to have the tool administrator verify permissions before publishing.
Example Tool: {{tool_name}} = "the portfolio tracker"; audience = project managers and PMO analysts; workflows = log a risk, update a milestone, run a status report.