Documenting the Prompt
Final documentation for each project prompt prepares it for inclusion in your prompt library and for sharing with others.
8 min•By Priygop Team•Updated 2026
Final Documentation Template
Final Documentation Template
# Final documentation template for each project prompt
prompt_documentation = {
"name": "[SHORT, DESCRIPTIVE NAME]",
"category": "[WRITING / CODING / RESEARCH / COMMUNICATION / ANALYSIS]",
"professional_context": "[DEVELOPER / CONTENT CREATOR / ANALYST / STUDENT / ETC.]",
"purpose": "[ONE SENTENCE: WHAT THIS PROMPT IS FOR]",
"when_to_use": "[SPECIFIC SITUATIONS WHERE THIS PROMPT WORKS WELL]",
"template": """
[FULL PROMPT TEMPLATE WITH {{VARIABLES}}]
""",
"variable_guide": {
"{{variable_1}}": "[DESCRIPTION OF WHAT TO PUT HERE]",
"{{variable_2}}": "[DESCRIPTION OF WHAT TO PUT HERE]",
},
"expected_output": "[DESCRIBE WHAT A GOOD RESPONSE LOOKS LIKE]",
"evaluation_results": {
"accuracy": "4/5",
"relevance": "5/5",
"clarity": "4/5",
"consistency": "4/5",
"format": "5/5",
},
"known_limitations": "[SCENARIOS WHERE THIS PROMPT MAY NOT WORK WELL]",
"tested_with": "[ChatGPT GPT-4o / Gemini 1.5 / Claude 3.5 Sonnet]",
"last_tested": "2025-08",
"status": "Approved",
}
print("Complete documentation makes each prompt a professional library entry.")Diagram
Loading diagram…
Deep Learning ⊂ Machine Learning ⊂ Artificial Intelligence
Key Takeaways
- Documentation includes: name, purpose, template, variables, expected output, and evaluation scores
- Known limitations help users know when to be careful
- Mark the AI tools each prompt has been tested with
- Approved status means the prompt passed final evaluation
- Good documentation transforms a prompt into a professional library entry
Key Takeaways
- Final documentation for each project prompt prepares it for inclusion in your prompt library and for sharing with others.
- Documentation includes: name, purpose, template, variables, expected output, and evaluation scores
- Known limitations help users know when to be careful
- Mark the AI tools each prompt has been tested with