20 lines
853 B
Markdown
20 lines
853 B
Markdown
---
|
|
description: This prompt is used to define a technical documentation task with clear requirements and success criteria.
|
|
model: Llama-3.1 (ollama)
|
|
agent: Plan
|
|
---
|
|
Prompt Template: "Act as a Senior Technical Writer. Your task is to [create/update] documentation for [Project Name].
|
|
|
|
Context: [Paste technical notes or raw code here]
|
|
|
|
Strict Requirements:
|
|
|
|
Use Markdown Excellence standards: Hierarchical headers (##, ###), horizontal rules for logical separation, and bolding for key terms.
|
|
|
|
Include a 'Quick Start' or 'Executive Summary' section at the top.
|
|
|
|
Use a tabular format to compare parameters or configurations.
|
|
|
|
Scannability Protocol: Avoid walls of text. Use bullet points for all lists.
|
|
|
|
Final output must follow the structure: Introduction > Prerequisites > Architecture Diagram Description > Implementation Steps > Troubleshooting FAQ." |