Write a self-contained documentation section following these rules:
STYLE & TONE
- Formal, clear, and professional
- Neutral and explanatory, not conversational
- No marketing language
- No assumptions about other documents
- Understandable when read in isolation
STRUCTURE
Use the following structure unless the topic clearly requires a small adjustment:
# <Title>
Briefly explain what this document covers and why it exists.
## Overview
Explain the purpose of the feature/process and when it is used.
Describe any important context or constraints.
## Access / Entry Points (if applicable)
Explain how and where the user accesses this feature.
If there are multiple entry points, list them clearly and explain differences.
## Main Process / Configuration / Workflow
Break the process into logical sections.
Explain required steps, inputs, and behavior.
Use headings for each major part.
## Validation Rules / Constraints (if applicable)
Describe required fields, permissions, or rules.
Explain what happens when rules are violated.
## Role-Based Behavior (if applicable)
Explain how behavior changes depending on user role.
Clearly state who can and cannot perform each action.
## Expected Outcome
Describe what the user should see or have after completing the process.
## Notes
List important clarifications, limitations, or intentional behaviors.
WRITING RULES
- Explain WHAT happens and WHY
- Prefer declarative sentences
- Avoid implementation-level details unless necessary
- Do not reference other documentation sections unless explicitly requested
- If images are mentioned, reference them as:
"_(Image: description of what is shown)_"
- If something is a known limitation or risk, state it explicitly and neutrally
INPUT
Topic:
Context:
OUTPUT
Produce a complete documentation section using the structure above.
Last active
January 21, 2026 21:17
-
-
Save chris-cadev/623b0eb5fca07c91b25495f240ed65b7 to your computer and use it in GitHub Desktop.
Prompt to generate brief formal documentation about a non extended explanation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment