콘텐츠로 이동

Prompts & Templates

AI prompt engineering resources and templates for documentation

Usage contract

  • Prompts structure a task; they do not grant tools, execute SQL, inspect repositories, or verify facts unless those capabilities are explicitly connected.
  • Replace placeholders with bounded context, audience, source paths, versions, constraints, exclusions, and the required evidence format.
  • Require outputs to label confirmed facts, inferences, recommendations, and unresolved questions.
  • A prompt result is ready to publish only after source-backed review, security/privacy checks, and task-specific validation.

Available Prompts

  • Document Editor

    Guidelines for writing and maintaining technical documentation.

    View Guide

  • Database Prompt

    Prompts for database schema design and optimization.

    View Prompt

  • Architecture Design

    Comprehensive prompts for software architecture documentation.

    View Guide

Prompt Categories

mindmap
  root((AI Prompts))
    Documentation
      Technical Writing
      API Docs
      User Guides
    Architecture
      C4 Model
      System Design
      Component Design
    Database
      Schema Design
      Query Optimization
      Migration Plans
    Code
      Code Review
      Refactoring
      Testing

Usage Guidelines

Best Practices

  1. Be Specific: Provide clear context and requirements
  2. Use Examples: Include sample inputs/outputs when possible
  3. Iterate: Refine prompts based on results
  4. Document: Keep track of effective prompts

Prompt Structure

# Role
Define the AI's persona and expertise level

# Context
Provide background information and constraints

# Task
Clearly state what needs to be accomplished

# Output Format
Specify the expected format and structure

# Examples (Optional)
Show sample inputs and expected outputs