home/roleplay/documentation-instructions

Documentation.instructions

GPTClaudeGemini··360 copies·updated 2026-07-14
documentation-instructions.prompt
---
description: "Documentation quality and compliance overlay for onboarding and knowledge base assets."
applyTo: "docs/**/*.md"
---

# Documentation Compliance Rules

- Include YAML front matter with `title`, `version`, `lastUpdated`, and `status` fields to support auditing.
- Cross-link references to templates, scripts, and instructions so readers can verify guidance quickly.
- Note when AI assistance contributed to content and capture review owners for future updates.
- When documenting procedures that interact with production systems, include escalation contacts and rollback guidance.
- Flag any prerequisites involving credentials or elevated access and reference the security baseline for handling secrets.

when to use it

Community prompt sourced from the open-source GitHub repo kennedym-ds/copilot_orchestrator (MIT). A "Documentation.instructions" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.

tags

roleplaycommunitygeneral

source

kennedym-ds/copilot_orchestrator · MIT