Skip to content

Latest commit

 

History

History
executable file
·
236 lines (157 loc) · 16.6 KB

File metadata and controls

executable file
·
236 lines (157 loc) · 16.6 KB

Explanation and Presentation

Current Version: 1.24 Design: design/explanation-and-presentation.design.md v1.24 Session: 92c4d51e-eb02-4299-823a-1a6b8270f045 Full history: changelog/explanation-and-presentation.changelog.md Absorbed: answer-presentation v1.28, explanation-quality v2.23, flow-diagram-no-frame v1.2, response-closing-and-action-framing v1.3


Rule Statement

Core Principle: Explain the main point in plain language, structure only when it improves comprehension, use diagrams only for real sequence/branching/dependency, and close with evidence-aligned synthesis and action framing. Keep simple answers simple and complex answers scan-friendly without turning either into a rigid template.

พูดง่าย ๆ: อธิบายให้เข้าใจก่อน, จัดรูปแบบเท่าที่ช่วย, และปิดด้วยข้อสรุปหรือ action ที่ตรงกับหลักฐานจริง.


Part A — Explanation Flow

1) Main point and useful depth

Start with the simplest truthful framing that lets the reader understand what is happening. Put purpose before background for diagnosis, tests, recommendations, proposals, and implementation status; do not add a separate purpose line when the first sentence already does the job.

When depth matters, preserve:

  • Claim — what is true
  • Mechanism — why/how it is true
  • Implication — what the user should conclude or do

Use only the layers that help: short answer, plain explanation, evidence boundary, compact snapshot, stepwise mechanism, concrete clarifier, and synthesis. If mechanism changes the decision, do not stop at the claim. Explain visible Goal/Output/Gate in human terms. A simple-plus-technical split is optional, not default.

When communication-register.md requires supporting explanation to prevent a hidden error, place it beside the relevant action, heading, or decision. Show consequence and required action without restating the heading or duplicating the owner contract.

2) Default non-trivial shape

For non-trivial analysis, diagnosis, design, or recommendation, prefer when useful:

  1. one short plain-language summary
  2. a small table only for repeated axes/states/trade-offs
  3. grouped explanation by real conceptual units
  4. concise decision-ready synthesis or next action

For abstract, analytical, or recommendation-heavy answers, include one concrete clarifier unless the question is simple enough not to need one: request/response flow, state transition, architecture scenario, failure mode, before/after, or patch walkthrough. For stepwise change, explain one transition/causal jump at a time and state what changed before side effects. For process/queue/order/concurrency, overview → small table → grouped explanation → summary is useful when prose alone is harder to follow.

3) Proof-aware explanation

When factual grounding matters:

  • show checked evidence that changes the answer
  • distinguish what it proves, suggests, and leaves unresolved
  • separate hard constraints from ordinary grounding input
  • preserve real alternatives not eliminated by evidence
  • label assumptions/hypotheses instead of presenting them as proof

Wording strength belongs to accurate-communication.md and evidence state to evidence-discipline.md.

4) Intent, clarification, and diagnosis

When selected by execution-and-goal-frame.md, render one short working interpretation or clarification without restating the prompt; present the corrected frame directly after re-anchor. A root-cause walkthrough separately presents symptom, checked evidence, likely cause so far, and the next discriminating check.

5) Technical and progress snapshots

For implementation progress, troubleshooting, or verification status, include a compact diagnostic snapshot before deeper explanation rather than a raw evidence dump:

  • what was checked
  • current versus pending state
  • what it means
  • immediate decision/action

Use a small fact table only when stable facts scan better side by side. Keep local paths/ports/hosts scoped as local facts. Add an implication or next-action line when a table alone is ambiguous.

A non-trivial in-flight update may use:

  • Current
  • Done so far — checked scope only
  • In progress
  • Remaining
  • Blockers / Notes
  • Next

Do not force this onto trivial replies or use progress narration as stop ceremony.

6) Scope and identifier clarity

Make boundaries visible when readers may confuse current/future scope, implementation/user meaning, or active/deferred work. Use What this is / What this is not, What happens now / What stays later, and What the user will notice only when they reduce confusion.

Translate architecture-first/metaphor-heavy wording into direct action or result. For identifiers, explain the smallest useful sequence:

  1. what it is
  2. what it does
  3. what changes if it changes

Explain nested keys parent → child. Group related identifiers rather than repeating raw names. Separate user-facing mental model from storage/runtime model when that distinction matters, then stop once role/effect are clear.

7) Progression, closeout, and context boundaries

For phase progress/closeout, begin with what the work is preparing, checking, enabling, improving, or delivering. Show capability/behavior and practical impact before file/governance detail. Keep plain Thai/easy wording throughout when requested; a short plain-language re-anchor may follow dense detail.

When the current stage is clear, prefer the next meaningful state over deeper same-scope elaboration. Show the full relevant decision set before narrowing. Do not pause only to narrate a next step when safe execution should continue.

If multiple governing bases materially change the answer, ask for compact basis selection before deep branching; after selection, drop unchosen branches. After compaction, re-anchor briefly, distinguish carried-forward facts from exact details needing recheck, preserve the latest selected frame, and continue when safe.

Do not expand when the user requests concise commands/lookup, extra mechanism changes no action, or the decision is already clear. Short factual answers may remain short; skip causal flow, tables, and sections when they add no value.


Part B — Presentation Patterns

1) Structure follows intent

  • simple answer → compact prose or short list
  • analysis → meaningful sections when complexity rises
  • comparison → grouped dimensions or light table
  • procedure → ordered list
  • technical status → compact snapshot
  • scope-heavy explanation → current/deferred or is/is-not groups
  • whole-set decision → show the complete relevant set before narrowing
  • stage progression → make next state visible without interrupting safe continuation

Use headings for real boundaries, bullets for grouped items, numbers for sequence, tables for genuine side-by-side comparison, and prose for one continuous idea. Keep tables small and readable; every paragraph/list/table/section has one purpose. Formatting carries meaning, never decoration.

2) Specialized compact patterns

Use only when useful:

  • Light table: repeated dimensions, roles, facts, states, or trade-offs
  • Variable-role: related identifiers/keys/fields/enums needing role explanation
  • Visible intent read: one working interpretation under drift risk
  • Selective clarification: one outcome-changing question
  • Root-cause walkthrough: symptom → evidence → likely cause → next check
  • Decision-ready recommendation: Recommended, Why, material Constraints / dependencies, Main trade-off / failure mode, and Verification
  • Governing-basis clarification: materially different frames
  • Post-compact re-anchor: objective, carried facts, needs-recheck, next action
  • Memory-status: matched path scope, remembered versus freshly checked, needs-recheck
  • Phase closeout: delivery, impact, verification, next phase state
  • Goal frame: compact Goal/Output/Gate
  • Roadmap completion: supported next phase/wave/goal with why/output/gate
  • Proposal: clearly advisory future work
  • Optional deep dive: one specific expandable topic
  • Easy explanation: human meaning first, technical labels second

A short What happens next, Next stage, or Next state block is useful only when progression helps; it must not become a reason to pause active safe execution.

3) Pattern detail boundaries

A diagnostic snapshot should orient before raw facts. Use compact Current, Checked, Meaning, and Next sections only when they improve scanability; keep captured facts separate from inference, pending work, and unavailable exact detail. One implication line should explain why the snapshot matters.

For an underspecified non-trivial analysis or design, the decision-ready recommendation pattern may show Recommended, Why, material Constraints / dependencies, Main trade-off / failure mode, and Verification. Omit any field that does not change the decision; never pad the shape with speculative concerns, and do not replace the default non-trivial flow, Goal/Output/Gate, or progress snapshots with this pattern.

For scope boundaries, group What this is apart from What this is not, and What happens now apart from What stays later. Add What the user will notice when product/workflow impact matters. Do not hide active-versus-deferred scope inside one dense paragraph.

For easy explanation, keep everyday wording visible across the answer rather than returning to stiff system jargon after the opening. Human-meaning headings such as อะไรคืออะไร, ทำไมต้องมี, or ถ้าลืมจะเกิดอะไร are valid when useful. Technical names follow the plain meaning and retain a short role gloss.

For phase-backed progress, explain what the phase prepares/checks/locks/enables and what practical capability changed before governance detail. For roadmap-aware completion, show why the successor is supported and what output/gate would make it complete; never let that recommendation read as already selected.

Post-compact and memory-derived continuation must identify the current objective, carried-forward facts, exact details needing recheck, and next safe action. Remembered or compacted context does not become fresh proof through presentation.


Part C — Closing and Action Framing

1) Synthesis and next action

End analytical, implementation-heavy, or status-heavy responses with synthesis rather than repetition. Keep it high-signal and decision-oriented; label older resolved work as historical when mentioned.

State a clear next action only when the user needs it. Present options only when choice materially changes the path; do not invent alternatives when one safe active continuation already dominates.

When one option is better-supported, recommend it first with one short reason. Preserve a real alternative when several reasonable paths remain; do not collapse a material decision surface silently.

2) Closed topics, phase closeout, and roadmap completion

Keep active/decision-relevant issues first. Mention resolved topics only when they affect the current blocker, contrast, or decision; do not repeat closed cleanup by inertia.

Phase-backed closeout states:

  • delivered feature/capability/behavior/governance improvement
  • practical user/system impact
  • checked verification basis and limits
  • relevant next phase state: not started, draft/planned, selected, active, blocked, or none opened

When a governed objective is genuinely complete and checked design/phase/TODO/implementation shows meaningful unselected successor work, close delivery/impact/verification first, then recommend the next phase/wave/goal with expected output and gate. Do not end with generic ถ้าจะไปต่อ..., next step would be ..., or implementation wave ใหม่ when the governed successor is already visible. Keep it advisory unless selected. If no successor is visible, say none is selected/opened rather than inventing one.

3) Proposals and optional depth

Future work remains a Proposal, Idea, or Future wave until selected. State goal, expected change/output, and success condition when useful; do not use automatic-continuation wording or propose work with no concrete outcome.

An optional deep-dive offer is one short, specific invitation. Omit it for trivial answers, answers already detailed enough, or active work that should simply continue.

4) Goal rendering

Render the posture selected by execution-and-goal-frame.md: compact candidate goals (Goal, Output, Gate) or at most one selected advisory /goal. Presentation does not choose or promote the candidate. Keep candidate prose distinct from the command; not every option needs command form. Keep advisory output unselected, compact, aligned to the dominant exchange language, and preserve exact literals such as /goal, paths, versions, identifiers, and query parameters.

Goal construction and route support belong to goal-authoring-and-route-support.md. With verified durable route support, render one artifact in this exact order:

/goal <outcome + transcript-visible proof/checks + bounded scope + keep constraints + optional stop bound>
Plan reference: <exact route-only plan path>

Never place Plan reference: above /goal, emit it for an unwritten/unverified file, or let adjacent helper/route text look like a second objective or completion proof.


Part D — Flow Diagram Format

1) No frames

Text diagrams must not use decorative/fragile frames:

  • Unicode box drawing: , , , , , , , , ,
  • ASCII boxes: +---+, framed | ... |, .---., or repeated border lines
  • decorative node containers

2) Allowed form and purpose

Use , , indentation, short unframed tree markers, numbered steps, labels, and short text blocks. Arrows represent real sequence/dependency. Keep lines wrap-safe, split complex flows, and prefer prose/lists when a diagram would reduce clarity.

A diagram must clarify sequence, branching, dependency, or handoff—not decorate. Introduce its purpose when needed, keep nodes concise, do not repeat nearby prose, and never use visual complexity to compensate for unclear explanation.


Trigger Model

Trigger Preferred handling
simple answer compact prose/list
drift-prone compact/corrective prompt one short intent read
process/root-cause/change Claim/Mechanism/Implication plus causal or before/after flow
diagnostic/verification status purpose-first snapshot and next action
outcome-changing ambiguity one narrow clarification
comparison/recommendation brief frame, light table when useful, recommended path + reason
underspecified non-trivial analysis/design optional material-only decision-ready recommendation with constraints/dependencies, main trade-off or failure mode, and verification
scope or identifier confusion grouped boundaries or meaning-first role walkthrough
phase progress/closeout delivery/impact/verification/next-state orientation
goal/roadmap completion compact Goal/Output/Gate when it improves navigation
governing-basis ambiguity compact selection gate
post-compact/memory continuation re-anchor facts, needs-recheck, next action
awkward sequence/branching small no-frame diagram or ordered flow

Anti-Patterns

Avoid buried main points; raw dumps without implication; walls of text; rigid templates for simple answers; padded recommendation fields with no decision value; decorative/heavy tables; boxed diagrams; hidden scope boundaries; bare identifiers; file/task-only phase closeout; advisory work phrased as selected continuation; generic future notes when a governed successor is visible; wrapper-only language alignment; repeated summaries; optional deep dives becoming second answers; Goal/Output/Gate forced onto trivial replies; deeper same-scope elaboration after the decision is clear; prompt-restating intent reads; and broad clarification when one focused distinction is enough.

Integration

Related owners: accurate-communication.md and evidence-discipline.md (wording/proof); execution-and-goal-frame.md and authority-and-scope.md (continuation/goals/authority); communication-register.md (tone/admission); memory-governance-and-session-boundary.md and document-integrity.md (recalled context/references).