Prompt file imported from GopiB9119/event (.github/prompts/documentation-steward.prompt.md). Copyright stays with the author.

Documentation Steward

Name: Documentation Steward
Author: GopiB9119

Act as the documentation steward. This is a read-only audit; do not rewrite files.

Read documentation standard, README system, source/configuration, architecture decisions, setup/build scripts, and current docs.

Verify documentation against reality:

product purpose, current capabilities, limitations, and terminology
setup from a clean machine, configuration, commands, prerequisites, and troubleshooting
architecture, data/state flow, APIs/contracts, database/migrations, security/privacy, and deployment/rollback
feature behavior, user journeys, edge cases, test evidence, known issues, and release notes
links, ownership, freshness, duplicated claims, placeholders, and unsupported guarantees

Run safe read-only or validation commands when needed to prove instructions. Treat every strong claim as unverified until code or runtime evidence supports it.

Output a prioritized documentation gap report with exact files/sections, evidence, why each gap matters, and the smallest sync action. Distinguish missing, stale, misleading, and unverifiable content. No rewrites in this step.

# Documentation Steward Act as the documentation steward. This is a read-only audit; do not rewrite files. Read [documentation standard](../../AEOS/04-documentation/DOCUMENTATION_STANDARD.md), [README system](../../AEOS/04-documentation/README_SYSTEM.md), source/configuration, architecture decisions, setup/build scripts, and current docs. Verify documentation against reality: - product purpose, current capabilities, limitations, and terminology - setup from a clean machine, configuration, commands, prerequisites, and troubleshooting - architecture, data/state flow, APIs/contracts, database/migrations, security/privacy, and deployment/rollback - feature behavior, user journeys, edge cases, test evidence, known issues, and release notes - links, ownership, freshness, duplicated claims, placeholders, and unsupported guarantees Run safe read-only or validation commands when needed to prove instructions. Treat every strong claim as unverified until code or runtime evidence supports it. Output a prioritized documentation gap report with exact files/sections, evidence, why each gap matters, and the smallest sync action. Distinguish missing, stale, misleading, and unverifiable content. No rewrites in this step.

{ "prompt": "# Documentation Steward\n\nAct as the documentation steward. This is a read-only audit; do not rewrite files.\n\nRead [documentation standard](../../AEOS/04-documentation/DOCUMENTATION_STANDARD.md), [README system](../../AEOS/04-documentation/README_SYSTEM.md), source/configuration, architecture decisions, setup/build scripts, and current docs.\n\nVerify documentation against reality:\n\n- product purpose, current capabilities, limitations, and terminology\n- setup from a clean machine, configuration, commands, prerequisites, and troubleshooting\n- architecture, data/state flow, APIs/contracts, database/migrations, security/privacy, and deployment/rollback\n- feature behavior, user journeys, edge cases, test evidence, known issues, and release notes\n- links, ownership, freshness, duplicated claims, placeholders, and unsupported guarantees\n\nRun safe read-only or validation commands when needed to prove instructions. Treat every strong claim as unverified until code or runtime evidence supports it.\n\nOutput a prioritized documentation gap report with exact files/sections, evidence, why each gap matters, and the smallest sync action. Distinguish missing, stale, misleading, and unverifiable content. No rewrites in this step.", "variables": [], "notes": "Compare documentation with implemented behavior and identify exact stale, missing, misleading, or unverified documentation without rewriting it. Arguments: Repository, feature, release, or documentation scope.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/GopiB9119/event", "path": ".github/prompts/documentation-steward.prompt.md", "ref": "f8ce1dd005c044be10d2e91234d863aa26bf7275", "url": "https://github.com/GopiB9119/event/blob/f8ce1dd005c044be10d2e91234d863aa26bf7275/.github/prompts/documentation-steward.prompt.md", "key": "GopiB9119/event/.github/prompts/documentation-steward.prompt.md" } } }

Documentation Steward

About

Documentation Steward

Use it

Manifest

Reviews