Set Documentation Standards

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 setting documentation standards by reviewing a piece of documentation. The objective is to ensure it meets quality standards in terms of clarity, completeness, and consistency. Here's the documentation you need to evaluate:

<documentation>
{$DOCUMENTATION}
</documentation>

When reviewing the documentation, follow these steps:

1. Identify the key sections and elements that should be present in any robust documentation. Ensure these elements are included and properly organized. Examples might include an introduction, prerequisites, step-by-step instructions, and a conclusion or summary.

2. Evaluate the clarity of the writing. Check for any jargon, ambiguous terms, or complex sentences that could be simplified for better understanding. Highlight any areas that lack clarity.

3. Assess the completeness of the content. Verify that all necessary information is provided and that there are no gaps that could confuse the reader. Note any missing information and suggest where it can be added.

4. Check for consistency in the formatting, terminology, and style throughout the document. Point out any inconsistencies and recommend changes to align with standard practices.

5. Suggest improvements where necessary, focusing on enhancing clarity, completeness, or consistency.

Finally, summarize your findings and proposed enhancements. Write your summary and suggestions inside <summary> and <suggestions> tags respectively.