PromptisePromptise
Why PromptiseUse casesRoadmapDocs
GitHubGet started
← All questions> Working as a team

What should prompt documentation include?

Include purpose, owner, inputs, outputs, dependencies (tools/retrieval), acceptance criteria, examples, and known failure modes. Record evaluation metrics, last review date, and change history. Keep docs short and current—they should help someone fix an issue in minutes.

In practice

Add a ‘first-aid’ section: what to check when outputs go wrong.

Where to start

  1. [01]Adopt a standard prompt header template.
  2. [02]Backfill docs for your top 10 prompts.
  3. [03]Link each prompt to its eval dashboard.
  4. [04]Review docs quarterly for accuracy.
prompt documentationprompt READMEdocumenting prompts

Related questions

// 001How do I onboard a team to prompt engineering?// 002How do I manage prompt changes without breaking downstream systems?// 003What should a prompt library include to stay useful?// 004How do I write effective prompt change logs?

Build it properly.

Promptise Foundry treats prompts as software — typed blocks, versioning, guards and an inspector that shows you every assembly decision.

Prompt engineering in FoundryRead the guides
Promptise - AI Framework LogoPromptise

The foundation layer for agentic intelligence. Build, secure and operate autonomous AI systems with Promptise Foundry.

pip install promptise

[01] Foundry

  • MCPcast
  • The Promptise Agent
  • Reasoning Engine
  • MCP
  • Agent Runtime
  • Prompt Engineering
  • Execution Engine
  • Agent Identity

[02] Resources

  • Documentation
  • GitHub
  • Guides
  • Learning Paths
  • Questions

[03] Company

  • About
  • Terms of Service
  • Privacy Policy
  • Cookie Policy
  • Subprocessors

© 2026 Promptise by Manser Ventures. All rights reserved.

Open source · Python