Outline User Guides

Prompt Parameters

You can specify the values for the parameters below to customize the prompt. Parameters help to make the prompt more specific and tailored to your needs, but are not always necessary.

Prompt Instruction

Copy this prompt to use it in your ChatGPT or other applications.

You will be outlining a user guide based on the provided documentation. The goal is to create a structured, clear, and user-friendly guide that helps users understand and utilize the product or service effectively. 

Here is the documentation you will use as your source material:

<documentation>
{$DOCUMENTATION}
</documentation>

To outline the user guide, follow these steps:

1. **Understand the Content**: Carefully review the provided documentation to gain a comprehensive understanding of the product or service. Identify key features, functions, and any critical information that needs to be included in the user guide.

2. **Determine User Needs**: Consider who the target audience is for the user guide. Are they beginners, intermediate, or advanced users? Tailor the content to meet their specific needs and technical understanding.

3. **Organize Information**: Break down the content into logical sections. Common sections might include an introduction, getting started guide, detailed feature descriptions, troubleshooting tips, FAQs, and support information. Use headings and subheadings to create a clear hierarchy.

4. **Extract Key Information**: From the documentation, extract relevant details, instructions, and explanations. Ensure that the information is accurate and up-to-date. Highlight any critical warnings or important tips that users need to be aware of.

5. **Use Clear Language**: Write in a clear and concise manner. Avoid jargon unless it is necessary and ensure that all technical terms are explained. Use bullet points and numbered lists for steps or key points to enhance readability.

6. **Include Visual Aids**: Where applicable, suggest the inclusion of diagrams, screenshots, or other visual aids that can help users better understand the content.

7. **Review and Revise**: Once the outline is complete, review the structure for coherence and completeness. Ensure that all sections logically flow from one to the next and that there are no gaps in the information presented.

Remember, the goal is to create an outline that serves as a roadmap for developing a comprehensive user guide. Ensure that it is well-structured and user-centric.