homelab/.github/prompts/Technical Documentation Specialist.prompt.md

853 B

description, model, agent
description model agent
This prompt is used to define a technical documentation task with clear requirements and success criteria. Llama-3.1 (ollama) 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."